POST api/Webhooks

Add Webhook

Request Information

URI Parameters

None.

Body Parameters

Webhook object

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

Request 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:47:28.2328216+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:47:28.2328216+01:00",
          "ResponseStatusCode": 4,
          "ResponseDate": "2025-12-27T13:47:28.2328216+01:00"
        },
        {
          "Id": 1,
          "WebhookMessageId": 2,
          "SentDate": "2025-12-27T13:47:28.2328216+01:00",
          "ResponseStatusCode": 4,
          "ResponseDate": "2025-12-27T13:47:28.2328216+01:00"
        }
      ]
    },
    {
      "Id": 1,
      "WebhookId": 2,
      "CreateDate": "2025-12-27T13:47:28.2328216+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:47:28.2328216+01:00",
          "ResponseStatusCode": 4,
          "ResponseDate": "2025-12-27T13:47:28.2328216+01:00"
        },
        {
          "Id": 1,
          "WebhookMessageId": 2,
          "SentDate": "2025-12-27T13:47:28.2328216+01:00",
          "ResponseStatusCode": 4,
          "ResponseDate": "2025-12-27T13:47:28.2328216+01:00"
        }
      ]
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Id=value&Url=value&IsActive=value&OwnerUserId=value&OwnerUser=value&Messages=value

Response Information

Resource Description

Webhook object

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:47:28.2484361+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:47:28.2484361+01:00",
          "ResponseStatusCode": 4,
          "ResponseDate": "2025-12-27T13:47:28.2484361+01:00"
        },
        {
          "Id": 1,
          "WebhookMessageId": 2,
          "SentDate": "2025-12-27T13:47:28.2484361+01:00",
          "ResponseStatusCode": 4,
          "ResponseDate": "2025-12-27T13:47:28.2484361+01:00"
        }
      ]
    },
    {
      "Id": 1,
      "WebhookId": 2,
      "CreateDate": "2025-12-27T13:47:28.2484361+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:47:28.2484361+01:00",
          "ResponseStatusCode": 4,
          "ResponseDate": "2025-12-27T13:47:28.2484361+01:00"
        },
        {
          "Id": 1,
          "WebhookMessageId": 2,
          "SentDate": "2025-12-27T13:47:28.2484361+01:00",
          "ResponseStatusCode": 4,
          "ResponseDate": "2025-12-27T13:47:28.2484361+01:00"
        }
      ]
    }
  ]
}