Webhooks

Create Webhooks

post/v1/Webhooks

Request

  • Base URL: https://api.channeladvisor.com
  • URL: https://api.channeladvisor.com/v1/Webhooks
  • Auth: OAuth 2 (authorization code, authorization URL https://api.channeladvisor.com/oauth2/authorize, token URL https://api.channeladvisor.com/oauth2/token; implicit, authorization URL https://api.channeladvisor.com/oauth2/authorize, scopes: orders, inventory) and HTTP bearer

Request body

Namestring nullable
Status'Deleted' | 'Enabled' | 'Disabled' | 'Suspended'
AuthenticationType'Unknown' | 'SigningSecret' | 'CustomHeader' | 'BasicAuth'
WebhookUristring nullable
EventTypesChannelAdvisorRestApiV1ModelsWebhookEventType[]

Example request

{
  "Name": "string",
  "Status": "Deleted",
  "AuthenticationType": "Unknown",
  "WebhookUri": "string",
  "EventTypes": [
    "Unknown"
  ]
}

Response

Created entity

IDnumber
Namestring nullable
Status'Deleted' | 'Enabled' | 'Disabled' | 'Suspended'
AuthenticationType'Unknown' | 'SigningSecret' | 'CustomHeader' | 'BasicAuth'
WebhookUristring nullable
SigningSecretstring nullable
EventTypesChannelAdvisorRestApiV1ModelsWebhookEventType[]

Example response

{
  "ID": 0,
  "Name": "string",
  "Status": "Deleted",
  "AuthenticationType": "Unknown",
  "WebhookUri": "string",
  "SigningSecret": "string",
  "EventTypes": [
    "Unknown"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.