WebhooksRegistrar un webhook
Volver a Sofia

Webhooks

Registrar un webhook

Registra una URL https a la que Sofia llama con un evento JSON firmado, reintentado hasta cinco veces si falla. Secreto visible una vez; máximo 10 webhooks.

POSThttps://api.sofia-post.com/api/v1/webhooks
POST/v1/webhooks

Esta petición actúa sobre tu cuenta real.

curl -X POST 'https://api.sofia-post.com/api/v1/webhooks' \
  -H "Authorization: Bearer $SOFIA_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{"url":"https://crm.example.com/hooks/sofia","events":["post.published"]}'

Autorizaciones

  • Authorizationstringobligatorio

    Tu clave personal o token de acceso OAuth, enviado como Bearer <token>.

Cuerpo

application/json

  • urlstringobligatorio

    La dirección https a la que llama Sofia. Se rechaza un host que resuelva a una dirección privada, loopback o link-local

  • eventsstring[]obligatorio

    Los eventos que recibir

Respuesta

201application/json

El webhook y su secreto de firma, mostrado una sola vez.

  • idstringobligatorio

    Identificador del webhook.

  • urlstringobligatorio

    Dirección a la que llama Sofia

  • eventsstring[]obligatorio

    Los eventos suscritos

  • createdAtstring<date-time>obligatorio

    Cuándo se registró el webhook

  • secretstringobligatorio

    La clave HMAC-SHA256 que firma cada envío (Sofia-Signature). Se muestra solo esta vez

400

webhook_url_invalid: no es https, o es un host privado, loopback o link-local. webhook_event_invalid: evento desconocido, o ninguno.

401

El token falta, es desconocido, ha caducado o está revocado.

403

El token no tiene el permiso webhooks:write.

409

webhook_limit_reached: ya hay 10 webhooks.

4XXapplication/json

Cualquier otro error, en el sobre de error.