GET api/Webhooks/{id}?fullResult={fullResult}&responseStatusType={responseStatusType}

Get Webhook by Id

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Id (key) of Webhook	integer	Required
fullResult	Full result of connected entities	FullResultEnum	Default value is Yes
responseStatusType	Filter on message responses	WebhookResponseStatusType	Default value is All

Body Parameters

None.

Response Information

Resource Description

Webhook object by id

WebhookDto

Name	Type	Additional information
Id	integer	Required
Url	string	Required
IsActive	boolean	None.
OwnerUserId	string	None.
OwnerUser	UserDto	None.
Messages	Collection of WebhookMessageDto	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Url": "sample string 2",
  "IsActive": true,
  "OwnerUserId": "sample string 4",
  "OwnerUser": {
    "Id": "sample string 1",
    "UserName": "sample string 2",
    "Email": "sample string 3",
    "Phone": "sample string 4"
  },
  "Messages": [
    {
      "Id": 1,
      "WebhookId": 2,
      "CreateDate": "2025-12-27T13:53:57.577167+01:00",
      "CreateUserId": "sample string 4",
      "CreateUser": {
        "Id": "sample string 1",
        "UserName": "sample string 2",
        "Email": "sample string 3",
        "Phone": "sample string 4"
      },
      "MessageKey": "sample string 5",
      "MessageCommandVerb": 1,
      "MessageCommandVerbText": "sample string 6",
      "MessageEntityVerb": 101,
      "MessageEntityVerbText": "sample string 7",
      "MessageHRef": "sample string 8",
      "MessageId": 9,
      "Responses": [
        {
          "Id": 1,
          "WebhookMessageId": 2,
          "SentDate": "2025-12-27T13:53:57.577167+01:00",
          "ResponseStatusCode": 4,
          "ResponseDate": "2025-12-27T13:53:57.577167+01:00"
        },
        {
          "Id": 1,
          "WebhookMessageId": 2,
          "SentDate": "2025-12-27T13:53:57.577167+01:00",
          "ResponseStatusCode": 4,
          "ResponseDate": "2025-12-27T13:53:57.577167+01:00"
        }
      ]
    },
    {
      "Id": 1,
      "WebhookId": 2,
      "CreateDate": "2025-12-27T13:53:57.577167+01:00",
      "CreateUserId": "sample string 4",
      "CreateUser": {
        "Id": "sample string 1",
        "UserName": "sample string 2",
        "Email": "sample string 3",
        "Phone": "sample string 4"
      },
      "MessageKey": "sample string 5",
      "MessageCommandVerb": 1,
      "MessageCommandVerbText": "sample string 6",
      "MessageEntityVerb": 101,
      "MessageEntityVerbText": "sample string 7",
      "MessageHRef": "sample string 8",
      "MessageId": 9,
      "Responses": [
        {
          "Id": 1,
          "WebhookMessageId": 2,
          "SentDate": "2025-12-27T13:53:57.577167+01:00",
          "ResponseStatusCode": 4,
          "ResponseDate": "2025-12-27T13:53:57.577167+01:00"
        },
        {
          "Id": 1,
          "WebhookMessageId": 2,
          "SentDate": "2025-12-27T13:53:57.577167+01:00",
          "ResponseStatusCode": 4,
          "ResponseDate": "2025-12-27T13:53:57.577167+01:00"
        }
      ]
    }
  ]
}