X Image Splitter logoX Image Splitter
X Image Splitter logoX Image Splitter

Developers

Register a Webhook Endpoint

POST
/webhooks/endpoints

Registers a public https URL for the chosen event types. It receives nothing until verify_webhook_endpoint succeeds. The plaintext secret (whsec_…) appears only in this response and can never be read again; store it now to verify deliveries.

Authorization

headerAuthorizationBearer <token>

An API Key the User creates in account settings, sent as Authorization: Bearer <key>. It holds the Scopes chosen at creation.

Request Body

application/json
  1. body
url*string
Length1 <= length <= 2048
eventTypes*array<>
Items1 <= items

Response Body

Success.

application/json
  1. response
endpoint*
secret*string
Example request
curl -X POST 'https://ximagesplitter.com/api/v1/webhooks/endpoints' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "string",
  "eventTypes": [
    "generation.queued"
  ]
}'
Example response
{
  "endpoint": {
    "id": "string",
    "url": "string",
    "eventTypes": [
      "generation.queued"
    ],
    "status": "unverified",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  },
  "secret": "string"
}