Passer au contenu principal
PATCH
Update Webhook

Autorisations

Authorization
string
header
requis

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.

Paramètres de chemin

webhook-id
string
requis

Id of the webhook.

Corps

application/json
url
string<uri> | null

The URL to send the webhook event to.

Required string length: 1 - 2083
channel
enum<string> | null

The channel that triggers this webhook.

Options disponibles:
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 | null

Webhook secret to be used in signature generation.

Maximum string length: 32
Exemple:

"t948Lf__j1WNwcAxZpsz8Q"

Réponse

Successful Response

id
string
requis

Id of the webhook.

marketplaceId
string<uuid>
requis

The marketplace ID.

url
string<uri>
requis

The URL to send the webhook event to.

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

The channel that triggers this webhook.

Options disponibles:
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
requis

Webhook secret to be used in signature generation.