Saltar al contenido principal
POST
cURL

Autorizaciones

Authorization
string
header
requerido

Para tus propios scripts e integraciones de servidor a servidor. Crea una clave en la app en Configuración > Acceso > Claves de API y cópiala entonces, porque se muestra una sola vez. Envíala como Authorization: Bearer <key>. La clave actúa como el miembro que la creó, en la organización en la que se creó. Una llamada necesita el permiso del miembro y uno de los alcances de la clave, como inventory:read o sales:write. Una clave con * tiene todos los alcances.

Cuerpo

application/json

La URL y los eventos de un endpoint de webhook y, al cambiarlo, si está activado.

url
string<uri>
requerido

Una URL HTTPS en internet. Se rechazan las direcciones privadas, de loopback y de enlace local, también después de resolver el DNS.

Maximum string length: 2048
events
string[]
requerido

Los eventos que se envían, como catalog.item.created.

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

Si se envían las entregas. Solo al cambiar un endpoint.

Respuesta

WebhookSecretResource

data
WebhookSecretResource · object
requerido

Un endpoint de webhook y su secreto de firma, que se muestra solo esta vez.