Webhooks

Create webhook endpoint

post/v1/webhooks

Request

Base URL: https://api.predictasiax.com
URL: https://api.predictasiax.com/v1/webhooks
Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional. Backend does NOT enforce for this endpoint (only /v1/orders and /v1/orders/batch require it). Portal SDK auto-injects one for safety. Format: [A-Za-z0-9_-]{8,128}.

Request body

app_idstring required

Owning app id (app_*). Must belong to the caller.

urlstring uri required

HTTPS delivery endpoint. No userinfo, no fragment.

eventsstring[] required

Event catalog. Unknown events return WEBHOOK_EVENT_UNKNOWN.

labelstring

Optional short label for the webhook.

descriptionstring

Optional longer description.

Example request

{
  "app_id": "app_9f8391eacbb0",
  "url": "https://example.com/pax-webhook"
}

Response

Webhook created. Signing secret returned ONCE — store immediately.

Example response

{
  "data": {
    "webhook": {
      "id": "wh_175d999188ca"
    },
    "signing_secret": "whsec_b841760a04a6efa1b768a0395e76ea73"
  }
}

Changes

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