Passer au contenu principal
POST
cURL

Autorisations

Authorization
string
header
requis

Pour vos propres scripts et vos intégrations de serveur à serveur. Créez une clé dans l'application sous Paramètres > Accès > Clés d'API et copiez-la à ce moment-là, car elle n'est affichée qu'une fois. Envoyez-la sous la forme Authorization: Bearer <key>. La clé agit en tant que le membre qui l'a créée, dans l'organisation où elle a été créée. Un appel exige l'autorisation du membre et l'une des portées de la clé, comme inventory:read ou sales:write. Une clé avec * a toutes les portées.

Corps

application/json

L'URL et les événements d'un point de terminaison webhook et, lors d'une modification, s'il est activé.

url
string<uri>
requis

Une URL HTTPS sur Internet. Les adresses privées, de bouclage et de lien local sont refusées, y compris après résolution DNS.

Maximum string length: 2048
events
string[]
requis

Les événements à envoyer, comme catalog.item.created.

Minimum array length: 1
Maximum string length: 100
enabled
boolean

Indique si les livraisons sont envoyées. Seulement lors de la modification d'un point de terminaison.

Réponse

WebhookSecretResource

data
WebhookSecretResource · object
requis

Un point de terminaison webhook et son secret de signature, qui n'est affiché qu'une seule fois.