Webhooks

Créer un endpoint de webhook

Abonne une URL https à des événements. Renvoie le secret de signature EN CLAIR une seule fois (à stocker côté abonné). L'URL est validée (https + anti-SSRF) puis immuable. Scope requis : webhooks:write.

post/webhooks

Request

  • Base URL: https://api.swipify.fr/api/v1
  • URL: https://api.swipify.fr/api/v1/webhooks
  • Auth: API key in header X-API-Key

Request body

urlstring uri required

URL https de destination (http interdit ; IP privées/loopback/métadonnées refusées, anti-SSRF).

eventsWebhookEventType[] required
descriptionstring nullable
activeboolean

Example request

{
  "url": "https://hooks.example.com/swipify"
}

Response

Endpoint créé (secret renvoyé une seule fois)

idinteger
urlstring uri
eventsWebhookEventType[]
descriptionstring nullable
activeboolean
secretPrefixstring

Préfixe du secret (indice d'identification ; jamais le secret complet).

lastTriggeredAtstring date-time nullable
createdAtstring date-time
secretstring

Secret de signature EN CLAIR, renvoyé UNE SEULE FOIS. À stocker côté abonné pour vérifier l'en-tête Swipify-Signature.

Example response

{
  "url": "https://hooks.example.com/swipify",
  "secretPrefix": "whsec_AbC12xYz",
  "secret": "whsec_AbC12xYz9..."
}

Changes

No recorded changes to this operation across all 1 revision of this API.