Register a webhook endpoint

Create a receiver. The signing secret is shown once.

POST /v1/webhook-endpoints

Register a webhook endpoint

cURL

curl --request POST \
  --url https://api.swapnice.com/v1/webhook-endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "url": "<string>",
  "enabled_events": []
}
'

201

{
  "endpoint": {
    "id": "<string>",
    "url": "<string>",
    "enabled_events": [
      "<string>"
    ],
    "status": "active",
    "created_at": "2023-11-07T05:31:56Z"
  },
  "signing_secret": "<string>"
}

Create a receiver. The signing secret is shown once.

Registration is live. Delivery is near-term. See webhooks.

Authorizations

Authorization · string · header · required

OAuth 2.1 authorization code with PKCE. Implicit and password flows are unsupported.

Headers

Idempotency-Key · string · required

Required for mutating requests. Replays with the same key and payload hash return the original logical result; replays with a different payload hash return 409.

Required string length: 16 - 255

Body

application/json

url · string<uri> · required

enabled_events · enum<string>[] · required

Minimum array length: 1

Available options: event.processed, event.failed, consent.revoked, profile.updated

Response

201

application/json

Webhook endpoint registered. The signing secret is shown once.

endpoint · object · required

Show child attributes

signing_secret · string · required

One-time webhook HMAC signing secret.