Propelus
Webhooks

Delete Webhook

Soft-delete a webhook. The record is retained for 48h with status=deleted before being pruned by DynamoDB TTL.

DELETE
/v2/webhooks/{webhookId}

Authorization

apiKey clientId
x-api-key<token>

In: header

x-client-id<token>

In: header

Path Parameters

webhookId*string

Unique identifier for the webhook.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/v2/webhooks/628fc8e2-ee7e-4779-9eb7-d980e7a92f3a"
{
  "status": 200,
  "code": "deleted",
  "detail": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}
{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}
{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}
{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}
{
  "status": 429,
  "detail": "string",
  "code": "f5d62b05-370e-48be-a755-8675ca146431"
}
{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}
{
  "status": 500,
  "detail": "string",
  "code": "unexpected_error"
}

Create Webhook POST

Register a webhook. The server synchronously POSTs an activation payload `{ "event": "activation", "code": "<6-char>" }` to the configured `url` using the configured `authentication` headers and records the outcome on the webhook: - 2xx response → record stored with `status: pending`, response `code: created_not_verified`. The caller's endpoint received the 6-character verification code; submit it to `POST /v2/webhooks/{webhookId}/activate` to transition the webhook to `active`. - non-2xx / network failure → record stored with `status: failed`, response `code: created_failed`. The `id` is returned in the same response envelope so the caller can `PATCH /v2/webhooks/{webhookId}` to retry the activation handshake (PATCH always re-runs the handshake when the stored record is `failed`). At most one webhook per `(client, eventType)` may be in `active`, `pending`, or `failed` state at once. `pending` and `failed` records carry a 7-day TTL; abandoned records are reaped automatically.

Get Webhooks GET

Retrieve all configured webhooks.