Skip to main content
PATCH
/
public
/
v1
/
webhooks
/
webhooks
/
{webhook-id}
Update Webhook
curl --request PATCH \
  --url https://api.topsort.com/public/v1/webhooks/webhooks/{webhook-id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "channel": "campaign:create",
  "secret": "<string>"
}
'
{
  "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. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Path Parameters

​
webhook-id
string
required

Id of the webhook.

Body

application/json
​
url
string<uri>

The URL to send the webhook event to.

Required string length: 1 - 2083
​
channel
enum<string>

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.

Maximum string length: 32
Example:

"t948Lf__j1WNwcAxZpsz8Q"

Response

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.