WebhooksEnregistrer un webhook
Retour à Sofia

Webhooks

Enregistrer un webhook

Enregistre une URL https que Sofia appelle avec un événement JSON signé, rejoué jusqu’à cinq fois en cas d’échec. Secret affiché une fois ; 10 webhooks max.

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

Cette requête agit sur votre vrai compte.

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"]}'

Autorisations

  • Authorizationstringrequis

    Votre clé personnelle ou jeton d’accès OAuth, envoyé sous la forme Bearer <token>.

Corps

application/json

  • urlstringrequis

    L’adresse https que Sofia appelle. Un hôte qui résout vers une adresse privée, loopback ou link-local est refusé

  • eventsstring[]requis

    Les événements à recevoir

Réponse

201application/json

Le webhook et son secret de signature, affiché une seule fois.

  • idstringrequis

    Identifiant du webhook.

  • urlstringrequis

    Adresse appelée par Sofia

  • eventsstring[]requis

    Les événements souscrits

  • createdAtstring<date-time>requis

    Moment où le webhook a été enregistré

  • secretstringrequis

    La clé HMAC-SHA256 qui signe chaque envoi (Sofia-Signature). Affichée cette seule fois

400

webhook_url_invalid : pas en https, ou hôte privé, loopback ou link-local. webhook_event_invalid : événement inconnu, ou aucun.

401

Le jeton est absent, inconnu, expiré ou révoqué.

403

Le jeton n’a pas la permission webhooks:write.

409

webhook_limit_reached : 10 webhooks déjà enregistrés.

4XXapplication/json

Toute autre erreur, dans l’enveloppe d’erreur.