Webhook endpoints

Register an endpoint

Start receiving signed messages at your server.

POST/v1/webhook-endpoints

See the webhook guide for how to check signatures.

Authentication

A signed-in session: the cookie from Log in. Changes also need the X-CSRF-Token header.

Body

urlstringrequired

Your HTTPS address.

eventsarrayrequired

conversion.succeeded, conversion.failed or conversion.cancelled.

descriptionstringoptional

A note for yourself.

Response

201 Created

webhook_endpointobject

id, url, description, events, created_at and previous_secret_expires_at.

secretstring

The signing secret. Store it now.

noticestring

A reminder that the secret won't be shown again.

Errors

Status	Code	What to do
400	`invalid_request`	The URL or events aren't valid. See `field`.
409	`too_many_webhook_endpoints`	Remove an endpoint first.
401	`unauthenticated`	Log in first, or log in again.
403	`csrf_failed`	Send the `csrf_token` as `X-CSRF-Token`.

Request

curl -b session.txt -X POST "https://rasternivo-api.swiftinfocorp.com/v1/webhook-endpoints" \
  -H "X-CSRF-Token: CSRF_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com/hook", "events": ["conversion.succeeded"]}'

Response 201

{
  "webhook_endpoint": {
    "id": "01a19b70-1111-7222-8333-444455556666",
    "url": "https://example.com/hook",
    "description": "",
    "events": ["conversion.succeeded"],
    "created_at": "2026-11-02T08:31:50Z",
    "previous_secret_expires_at": null
  },
  "secret": "whsec_…",
  "notice": "Store this signing secret now. It will not be shown again."
}