Create Webhook

Creates a webhook.

POST /public/v1/webhooks/webhooks

Try it

Create Webhook

cURL

curl --request POST \
  --url https://api.topsort.com/public/v1/webhooks/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "channel": "campaign:create",
  "secret": "<string>"
}
'

201

{
  "id": "<string>",
  "marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "channel": "campaign:create",
  "secret": "<string>"
}

Authorizations

Authorization · string · header · required

A valid API key generated in Topsort's UI.

Body

application/json

url · string<uri> · required

The URL to send the webhook event to.

Required string length: 1 - 2083

channel · enum<string> · required

The channel that triggers this webhook.

Available options: campaign:create, campaign:update, campaign:delete, catalog:feed:download:finish, store:availability:download:finish, catalog:feed:upload:late, full:availability:upload:late, delta:availability:upload:late

secret · string

Webhook secret to be used in signature generation. If missing, it'll be randomly generated.

Maximum string length: 32

Response

201

application/json

Successful Response

id · string · required

Id of the webhook.

marketplaceId · string<uuid> · required

The marketplace ID.

url · string<uri> · required

The URL to send the webhook event to.

Required string length: 1 - 2083

channel · enum<string> · required

The channel that triggers this webhook.

Available options: campaign:create, campaign:update, campaign:delete, catalog:feed:download:finish, store:availability:download:finish, catalog:feed:upload:late, full:availability:upload:late, delta:availability:upload:late

secret · string · required

Webhook secret to be used in signature generation.