Webhooks Schemas

Management.CreateWebhookSubscriptionDto


{
  "name": "string",
  "eventType": "string",
  "url": "string",
  "secret": "string",
  "headers": {
    "property1": "string",
    "property2": "string"
  },
  "maxRetryCount": 0,
  "isActive": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
eventType	string¦null	false	none	none
url	string¦null	false	none	none
secret	string¦null	false	none	none
headers	object¦null	false	none	none
» additionalProperties	string¦null	false	none	none
maxRetryCount	integer(int32)¦null	false	none	none
isActive	boolean¦null	false	none	none

Management.CreateWebhookSubscriptionRequest


{
  "subscription": {
    "name": "string",
    "eventType": "string",
    "url": "string",
    "secret": "string",
    "headers": {
      "property1": "string",
      "property2": "string"
    },
    "maxRetryCount": 0,
    "isActive": true
  }
}

Properties

Name	Type	Required	Restrictions	Description
subscription	Management.CreateWebhookSubscriptionDto	false	none	none

Management.CreateWebhookSubscriptionResponse


{
  "subscription": {
    "id": 0,
    "name": "string",
    "eventType": "string",
    "url": "string",
    "secret": "string",
    "maxRetryCount": 0,
    "isActive": true,
    "userId": "string",
    "headers": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "webhookEvents": [
      {
        "id": 0,
        "webhookSubscriptionId": 0,
        "eventType": "string",
        "payload": "string",
        "statusCode": 0,
        "response": "string",
        "errorMessage": "string",
        "isSuccess": true,
        "retryCount": 0,
        "sentAt": "2019-08-24T14:15:22Z",
        "nextRetryAt": "2019-08-24T14:15:22Z",
        "createdAt": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "success": true,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
subscription	Management.WebhookSubscription	false	none	none
success	boolean	false	none	none
message	string¦null	false	none	none

Management.DeleteWebhookEventResponse


{
  "success": true,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
message	string¦null	false	none	none

Management.DeleteWebhookSubscriptionResponse


{
  "success": true,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
message	string¦null	false	none	none

Management.GetWebhookEventTypesResponse


{
  "eventTypes": [
    {
      "name": "string",
      "description": "string"
    }
  ],
  "success": true,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
eventTypes	[Management.WebhookEventType]¦null	false	none	none
success	boolean	false	none	none
message	string¦null	false	none	none

Management.GetWebhookEventsResponse


{
  "events": [
    {
      "id": 0,
      "webhookSubscriptionId": 0,
      "eventType": "string",
      "payload": "string",
      "statusCode": 0,
      "response": "string",
      "errorMessage": "string",
      "isSuccess": true,
      "retryCount": 0,
      "sentAt": "2019-08-24T14:15:22Z",
      "nextRetryAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ],
  "totalEventsCount": 0,
  "success": true,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
events	[Management.WebhookEvent]¦null	false	none	none
totalEventsCount	integer(int32)	false	none	none
success	boolean	false	none	none
message	string¦null	false	none	none

Management.GetWebhookStatusResponse


{
  "isEnabled": true,
  "success": true,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
isEnabled	boolean	false	none	none
success	boolean	false	none	none
message	string¦null	false	none	none

Management.GetWebhookSubscriptionResponse


{
  "subscription": {
    "id": 0,
    "name": "string",
    "eventType": "string",
    "url": "string",
    "secret": "string",
    "maxRetryCount": 0,
    "isActive": true,
    "userId": "string",
    "headers": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "webhookEvents": [
      {
        "id": 0,
        "webhookSubscriptionId": 0,
        "eventType": "string",
        "payload": "string",
        "statusCode": 0,
        "response": "string",
        "errorMessage": "string",
        "isSuccess": true,
        "retryCount": 0,
        "sentAt": "2019-08-24T14:15:22Z",
        "nextRetryAt": "2019-08-24T14:15:22Z",
        "createdAt": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "success": true,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
subscription	Management.WebhookSubscription	false	none	none
success	boolean	false	none	none
message	string¦null	false	none	none

Management.GetWebhookSubscriptionsResponse


{
  "subscriptions": [
    {
      "id": 0,
      "name": "string",
      "eventType": "string",
      "url": "string",
      "secret": "string",
      "maxRetryCount": 0,
      "isActive": true,
      "userId": "string",
      "headers": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "webhookEvents": [
        {
          "id": 0,
          "webhookSubscriptionId": 0,
          "eventType": "string",
          "payload": "string",
          "statusCode": 0,
          "response": "string",
          "errorMessage": "string",
          "isSuccess": true,
          "retryCount": 0,
          "sentAt": "2019-08-24T14:15:22Z",
          "nextRetryAt": "2019-08-24T14:15:22Z",
          "createdAt": "2019-08-24T14:15:22Z"
        }
      ]
    }
  ],
  "totalSubscriptionsCount": 0,
  "success": true,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
subscriptions	[Management.WebhookSubscription]¦null	false	none	none
totalSubscriptionsCount	integer(int32)	false	none	none
success	boolean	false	none	none
message	string¦null	false	none	none

Management.SendWebhookTestEventRequest


{
  "payload": null
}

Properties

Name	Type	Required	Restrictions	Description
payload	any	false	none	none

Management.SendWebhookTestEventResponse


{
  "success": true,
  "message": "string",
  "eventId": 0
}

Properties

Name	Type	Required	Restrictions	Description
success	boolean	false	none	none
message	string¦null	false	none	none
eventId	integer(int32)¦null	false	none	none

Management.UpdateWebhookSubscriptionDto


{
  "name": "string",
  "eventType": "string",
  "url": "string",
  "secret": "string",
  "headers": {
    "property1": "string",
    "property2": "string"
  },
  "maxRetryCount": 0,
  "isActive": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
eventType	string¦null	false	none	none
url	string¦null	false	none	none
secret	string¦null	false	none	none
headers	object¦null	false	none	none
» additionalProperties	string¦null	false	none	none
maxRetryCount	integer(int32)¦null	false	none	none
isActive	boolean¦null	false	none	none

Management.UpdateWebhookSubscriptionRequest


{
  "subscription": {
    "name": "string",
    "eventType": "string",
    "url": "string",
    "secret": "string",
    "headers": {
      "property1": "string",
      "property2": "string"
    },
    "maxRetryCount": 0,
    "isActive": true
  }
}

Properties

Name	Type	Required	Restrictions	Description
subscription	Management.UpdateWebhookSubscriptionDto	false	none	none

Management.UpdateWebhookSubscriptionResponse


{
  "subscription": {
    "id": 0,
    "name": "string",
    "eventType": "string",
    "url": "string",
    "secret": "string",
    "maxRetryCount": 0,
    "isActive": true,
    "userId": "string",
    "headers": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "webhookEvents": [
      {
        "id": 0,
        "webhookSubscriptionId": 0,
        "eventType": "string",
        "payload": "string",
        "statusCode": 0,
        "response": "string",
        "errorMessage": "string",
        "isSuccess": true,
        "retryCount": 0,
        "sentAt": "2019-08-24T14:15:22Z",
        "nextRetryAt": "2019-08-24T14:15:22Z",
        "createdAt": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "success": true,
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
subscription	Management.WebhookSubscription	false	none	none
success	boolean	false	none	none
message	string¦null	false	none	none

Management.WebhookEvent


{
  "id": 0,
  "webhookSubscriptionId": 0,
  "eventType": "string",
  "payload": "string",
  "statusCode": 0,
  "response": "string",
  "errorMessage": "string",
  "isSuccess": true,
  "retryCount": 0,
  "sentAt": "2019-08-24T14:15:22Z",
  "nextRetryAt": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	none	none
webhookSubscriptionId	integer(int32)	false	none	none
eventType	string¦null	false	none	none
payload	string¦null	false	none	none
statusCode	integer(int32)¦null	false	none	none
response	string¦null	false	none	none
errorMessage	string¦null	false	none	none
isSuccess	boolean¦null	false	none	none
retryCount	integer(int32)	false	none	none
sentAt	string(date-time)¦null	false	none	none
nextRetryAt	string(date-time)¦null	false	none	none
createdAt	string(date-time)	false	none	none

Management.WebhookEventType


{
  "name": "string",
  "description": "string"
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
description	string¦null	false	none	none

Management.WebhookSubscription


{
  "id": 0,
  "name": "string",
  "eventType": "string",
  "url": "string",
  "secret": "string",
  "maxRetryCount": 0,
  "isActive": true,
  "userId": "string",
  "headers": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "webhookEvents": [
    {
      "id": 0,
      "webhookSubscriptionId": 0,
      "eventType": "string",
      "payload": "string",
      "statusCode": 0,
      "response": "string",
      "errorMessage": "string",
      "isSuccess": true,
      "retryCount": 0,
      "sentAt": "2019-08-24T14:15:22Z",
      "nextRetryAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
id	integer(int32)	false	none	none
name	string¦null	false	none	none
eventType	string¦null	false	none	none
url	string¦null	false	none	none
secret	string¦null	false	none	none
maxRetryCount	integer(int32)	false	none	none
isActive	boolean	false	none	none
userId	string¦null	false	none	none
headers	string¦null	false	none	none
createdAt	string(date-time)¦null	false	none	none
updatedAt	string(date-time)¦null	false	none	none
webhookEvents	[Management.WebhookEvent]¦null	false	none	none