GET api/Webhooks/{key}/MessageKey?fullResult={fullResult}&responseStatusType={responseStatusType}

Get WebhookMessage by Key

Request Information

URI Parameters

Name	Description	Type	Additional information
key	Key of WebhookMessage	string	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

WebhookMessageDto

Name	Type	Additional information
Id	integer	Required
WebhookId	integer	None.
Webhook	WebhookDto	None.
CreateDate	date	None.
CreateUserId	string	None.
CreateUser	UserDto	None.
MessageKey	string	None.
MessageCommandVerb	MessageCommandVerbType	None.
MessageCommandVerbText	string	None.
MessageEntityVerb	MessageEntityVerbType	None.
MessageEntityVerbText	string	None.
MessageHRef	string	None.
MessageId	integer	None.
Responses	Collection of WebhookMessageResponseDto	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "WebhookId": 2,
  "Webhook": {
    "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": []
  },
  "CreateDate": "2026-03-27T12:42:01.219517+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": "2026-03-27T12:42:01.219517+01:00",
      "ResponseStatusCode": 4,
      "ResponseDate": "2026-03-27T12:42:01.219517+01:00"
    },
    {
      "Id": 1,
      "WebhookMessageId": 2,
      "SentDate": "2026-03-27T12:42:01.219517+01:00",
      "ResponseStatusCode": 4,
      "ResponseDate": "2026-03-27T12:42:01.219517+01:00"
    }
  ]
}