PushizoDocs
API reference

Webhooks

Webhooks — 13 operations (GET /v1/apps/{appId}/webhooks/event-types, GET /v1/apps/{appId}/webhooks, POST /v1/apps/{appId}/webhooks, …). Generated from the OpenAPI 3.1.0 contract.

Outgoing webhook endpoints, secret rotation, test sends, delivery history and replay; see the “Webhooks” section for signature verification.

Base URL: https://api.pushizo.com · Tag: webhooks · Interactive docs (Scalar)

Operations

MethodPathOperation
GET/v1/apps/{appId}/webhooks/event-typesEvent types that can be subscribed to
GET/v1/apps/{appId}/webhooksWebhook endpoints
POST/v1/apps/{appId}/webhooksCreate an endpoint (the secret is returned only in this response)
POST/v1/apps/{appId}/webhooks/previewEvent Streams preview: sample event + template + filter → body/error (does not send)
GET/v1/apps/{appId}/webhooks/{webhookId}Endpoint details
PATCH/v1/apps/{appId}/webhooks/{webhookId}Update an endpoint (URL, events, batch, headers, enable/disable)
DELETE/v1/apps/{appId}/webhooks/{webhookId}Delete an endpoint
POST/v1/apps/{appId}/webhooks/{webhookId}/rotate-secretSecret rotation (the old secret is sent as a second signature for 24 hours)
POST/v1/apps/{appId}/webhooks/{webhookId}/testSend a test event (immediate, returns the result)
GET/v1/apps/{appId}/webhooks/{webhookId}/deliveriesDelivery history (cursor; status/event type filter)
POST/v1/apps/{appId}/webhooks/{webhookId}/replayReplay failed/dead deliveries in bulk (up to 1000)
GET/v1/apps/{appId}/webhooks/deliveries/{deliveryId}Delivery details (including the payload)
POST/v1/apps/{appId}/webhooks/deliveries/{deliveryId}/replayRedeliver (with the same event ID)

Details

Event types that can be subscribed to

GET/v1/apps/{appId}/webhooks/event-typesTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WebhookEventTypes

FieldTypeRequiredDescription
dataarray<string>Yes

Example response:

{
  "data": [
    "örnek"
  ]
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/webhooks/event-types" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Webhook endpoints

GET/v1/apps/{appId}/webhooksTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WebhookList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].urlstringYes
data[].descriptionstring | nullYes
data[].eventsarray<string>Yes
data[].event_filtersobjectYes
data[].event_filters.event_namesarray<string>No
data[].batchbooleanYes
data[].statusenumYesValues: "active", "failing", "disabled"
data[].disabled_reasonstring | nullYes
data[].failure_countintegerYes
data[].failing_sincestring | nullYes
data[].last_success_atstring | nullYes
data[].last_failure_atstring | nullYes
data[].header_namesarray<string>Yes
data[].previous_secret_expires_atstring | nullYes
data[].body_templatestring | nullYes
data[].body_content_typeenumYesValues: "application/json", "text/plain"
data[].filtersobject | nullYes
data[].created_atstringYes
data[].updated_atstringYes

Example response:

{
  "data": [
    {
      "url": "https://pushizo.com/orders/1001",
      "events": [
        "purchase"
      ],
      "status": "active",
      "id": "whe_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "description": "Sipariş durumu güncellemeleri",
      "event_filters": {
        "event_names": [
          "purchase"
        ]
      },
      "batch": true,
      "disabled_reason": "örnek",
      "failure_count": 1,
      "failing_since": "örnek",
      "last_success_at": "örnek",
      "last_failure_at": "örnek",
      "header_names": [
        "örnek"
      ],
      "previous_secret_expires_at": "örnek",
      "body_template": "örnek",
      "body_content_type": "application/json",
      "filters": {
        "match": "all",
        "conditions": [
          {}
        ]
      },
      "created_at": "örnek",
      "updated_at": "örnek"
    }
  ]
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/webhooks" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Create an endpoint (the secret is returned only in this response)

POST/v1/apps/{appId}/webhooksTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateWebhookDto

FieldTypeRequiredDescription
urlstringYesLength: 1–2048
descriptionstring | nullNo
eventsarray<enum>YesItems: 1–41
event_filtersobjectNo
event_filters.event_namesarray<string>NoItems: 0–50
batchbooleanNo
headersmap<string, string>No
body_templatestring | nullNo
body_content_typeenumNoContent type of the template output (default application/json).. Values: "application/json", "text/plain"
filtersobject | nullNo

Example:

{
  "url": "https://pushizo.com/orders/1001",
  "events": [
    "message.queued"
  ],
  "description": "Sipariş durumu güncellemeleri",
  "event_filters": {
    "event_names": [
      "purchase"
    ]
  },
  "batch": true,
  "headers": {
    "key": "user_42"
  },
  "body_template": "örnek"
}

Responses

201 — Success.

Schema: WebhookWithSecret

FieldTypeRequiredDescription
idstringYes
app_idstringYes
urlstringYes
descriptionstring | nullYes
eventsarray<string>Yes
event_filtersobjectYes
event_filters.event_namesarray<string>No
batchbooleanYes
statusenumYesValues: "active", "failing", "disabled"
disabled_reasonstring | nullYes
failure_countintegerYes
failing_sincestring | nullYes
last_success_atstring | nullYes
last_failure_atstring | nullYes
header_namesarray<string>Yes
previous_secret_expires_atstring | nullYes
body_templatestring | nullYes
body_content_typeenumYesValues: "application/json", "text/plain"
filtersobject | nullYes
created_atstringYes
updated_atstringYes
secretstringYesReturned only once, in the create and rotation responses.

Example response:

{
  "url": "https://pushizo.com/orders/1001",
  "events": [
    "purchase"
  ],
  "status": "active",
  "id": "whe_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "description": "Sipariş durumu güncellemeleri",
  "event_filters": {
    "event_names": [
      "purchase"
    ]
  },
  "batch": true,
  "disabled_reason": "örnek",
  "failure_count": 1,
  "failing_since": "örnek",
  "last_success_at": "örnek",
  "last_failure_at": "örnek",
  "header_names": [
    "örnek"
  ],
  "previous_secret_expires_at": "örnek",
  "body_template": "örnek",
  "body_content_type": "application/json",
  "filters": {
    "match": "all",
    "conditions": [
      {
        "field": "örnek",
        "op": "eq",
        "value": "user_42"
      }
    ]
  },
  "created_at": "örnek",
  "updated_at": "örnek",
  "secret": "örnek"
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/webhooks" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://pushizo.com/orders/1001",
  "events": [
    "message.queued"
  ],
  "description": "Sipariş durumu güncellemeleri",
  "event_filters": {
    "event_names": [
      "purchase"
    ]
  },
  "batch": true,
  "headers": {
    "key": "user_42"
  },
  "body_template": "örnek"
}'

Event Streams preview: sample event + template + filter → body/error (does not send)

POST/v1/apps/{appId}/webhooks/previewTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: WebhookPreviewDto

FieldTypeRequiredDescription
event_typeenumYesValues: "message.queued", "message.completed", "message.failed", "delivery.sent", "delivery.delivered", "delivery.failed", "delivery.opened", "delivery.clicked", "delivery.bounced", "delivery.complained", "delivery.unsubscribed", "in_app.impression", "in_app.clicked", "in_app.dismissed", "subscription.created", "subscription.unsubscribed", "subscription.invalidated", "user.created", "user.updated", "user.merged", "user.deleted", "event.received", "conversion.created", "campaign.scheduled", "campaign.started", "campaign.completed", "journey.entered", "journey.step_completed", "journey.completed", "journey.exited", "conversation.created", "conversation.message", "conversation.assigned", "conversation.resolved", "audit.created", "form.submitted", "survey.responded", "ad_audience.synced", "ad_account.revoked", "ad_budget.alert", "ad_insights.imported", "webhook.test"
datamap<string, any>No
body_templatestring | nullNo
body_content_typeenumNoContent type of the template output (default application/json).. Values: "application/json", "text/plain"
filtersobject | nullNo
batchbooleanNo

Example:

{
  "event_type": "message.queued",
  "data": {
    "order_id": "1001"
  },
  "body_template": "örnek",
  "body_content_type": "application/json",
  "filters": {
    "match": "all",
    "conditions": [
      {
        "field": "örnek",
        "op": "eq",
        "value": "user_42"
      }
    ]
  },
  "batch": true
}

Responses

200 — Success.

Schema: WebhookPreviewResult

FieldTypeRequiredDescription
payloadmap<string, any>Yes
matchedbooleanYesWhether the event passes the filter (if not, it is not sent).
failed_conditionsarray<object>Yes
failed_conditions[].fieldstringYes
failed_conditions[].opstringYes
failed_conditions[].valueanyNo
bodystring | nullYes
content_typestringYes
errorobject | nullYes

Example response:

{
  "payload": {
    "key": "örnek"
  },
  "matched": true,
  "failed_conditions": [
    {
      "field": "örnek",
      "op": "örnek",
      "value": "örnek"
    }
  ],
  "body": "Takip bağlantısı içeride",
  "content_type": "örnek",
  "error": {
    "code": "örnek",
    "message": "Takip bağlantısı içeride"
  }
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/webhooks/preview" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "event_type": "message.queued",
  "data": {
    "order_id": "1001"
  },
  "body_template": "örnek",
  "body_content_type": "application/json",
  "filters": {
    "match": "all",
    "conditions": [
      {
        "field": "örnek",
        "op": "eq",
        "value": "user_42"
      }
    ]
  },
  "batch": true
}'

Endpoint details

GET/v1/apps/{appId}/webhooks/{webhookId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
webhookIdpathstringYes"whe_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Webhook

FieldTypeRequiredDescription
idstringYes
app_idstringYes
urlstringYes
descriptionstring | nullYes
eventsarray<string>Yes
event_filtersobjectYes
event_filters.event_namesarray<string>No
batchbooleanYes
statusenumYesValues: "active", "failing", "disabled"
disabled_reasonstring | nullYes
failure_countintegerYes
failing_sincestring | nullYes
last_success_atstring | nullYes
last_failure_atstring | nullYes
header_namesarray<string>Yes
previous_secret_expires_atstring | nullYes
body_templatestring | nullYes
body_content_typeenumYesValues: "application/json", "text/plain"
filtersobject | nullYes
created_atstringYes
updated_atstringYes

Example response:

{
  "url": "https://pushizo.com/orders/1001",
  "events": [
    "purchase"
  ],
  "status": "active",
  "id": "whe_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "description": "Sipariş durumu güncellemeleri",
  "event_filters": {
    "event_names": [
      "purchase"
    ]
  },
  "batch": true,
  "disabled_reason": "örnek",
  "failure_count": 1,
  "failing_since": "örnek",
  "last_success_at": "örnek",
  "last_failure_at": "örnek",
  "header_names": [
    "örnek"
  ],
  "previous_secret_expires_at": "örnek",
  "body_template": "örnek",
  "body_content_type": "application/json",
  "filters": {
    "match": "all",
    "conditions": [
      {
        "field": "örnek",
        "op": "eq",
        "value": "user_42"
      }
    ]
  },
  "created_at": "örnek",
  "updated_at": "örnek"
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/webhooks/whe_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Update an endpoint (URL, events, batch, headers, enable/disable)

PATCH/v1/apps/{appId}/webhooks/{webhookId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
webhookIdpathstringYes"whe_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateWebhookDto

FieldTypeRequiredDescription
urlstringNoLength: 1–2048
descriptionstring | nullNo
eventsarray<enum>NoItems: 1–41
event_filtersobjectNo
event_filters.event_namesarray<string>NoItems: 0–50
batchbooleanNo
headersmap<string, string> | nullNo
statusenumNoValues: "active", "disabled"
body_templatestring | nullNo
body_content_typeenumNoContent type of the template output (default application/json).. Values: "application/json", "text/plain"
filtersobject | nullNo

Example:

{
  "url": "https://pushizo.com/orders/1001",
  "events": [
    "message.queued"
  ],
  "status": "active",
  "description": "Sipariş durumu güncellemeleri",
  "event_filters": {
    "event_names": [
      "purchase"
    ]
  }
}

Responses

200 — Success.

Schema: Webhook

FieldTypeRequiredDescription
idstringYes
app_idstringYes
urlstringYes
descriptionstring | nullYes
eventsarray<string>Yes
event_filtersobjectYes
event_filters.event_namesarray<string>No
batchbooleanYes
statusenumYesValues: "active", "failing", "disabled"
disabled_reasonstring | nullYes
failure_countintegerYes
failing_sincestring | nullYes
last_success_atstring | nullYes
last_failure_atstring | nullYes
header_namesarray<string>Yes
previous_secret_expires_atstring | nullYes
body_templatestring | nullYes
body_content_typeenumYesValues: "application/json", "text/plain"
filtersobject | nullYes
created_atstringYes
updated_atstringYes

Example response:

{
  "url": "https://pushizo.com/orders/1001",
  "events": [
    "purchase"
  ],
  "status": "active",
  "id": "whe_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "description": "Sipariş durumu güncellemeleri",
  "event_filters": {
    "event_names": [
      "purchase"
    ]
  },
  "batch": true,
  "disabled_reason": "örnek",
  "failure_count": 1,
  "failing_since": "örnek",
  "last_success_at": "örnek",
  "last_failure_at": "örnek",
  "header_names": [
    "örnek"
  ],
  "previous_secret_expires_at": "örnek",
  "body_template": "örnek",
  "body_content_type": "application/json",
  "filters": {
    "match": "all",
    "conditions": [
      {
        "field": "örnek",
        "op": "eq",
        "value": "user_42"
      }
    ]
  },
  "created_at": "örnek",
  "updated_at": "örnek"
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/webhooks/whe_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://pushizo.com/orders/1001",
  "events": [
    "message.queued"
  ],
  "status": "active",
  "description": "Sipariş durumu güncellemeleri",
  "event_filters": {
    "event_names": [
      "purchase"
    ]
  }
}'

Delete an endpoint

DELETE/v1/apps/{appId}/webhooks/{webhookId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
webhookIdpathstringYes"whe_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/webhooks/whe_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Secret rotation (the old secret is sent as a second signature for 24 hours)

POST/v1/apps/{appId}/webhooks/{webhookId}/rotate-secretTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
webhookIdpathstringYes"whe_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WebhookWithSecret

FieldTypeRequiredDescription
idstringYes
app_idstringYes
urlstringYes
descriptionstring | nullYes
eventsarray<string>Yes
event_filtersobjectYes
event_filters.event_namesarray<string>No
batchbooleanYes
statusenumYesValues: "active", "failing", "disabled"
disabled_reasonstring | nullYes
failure_countintegerYes
failing_sincestring | nullYes
last_success_atstring | nullYes
last_failure_atstring | nullYes
header_namesarray<string>Yes
previous_secret_expires_atstring | nullYes
body_templatestring | nullYes
body_content_typeenumYesValues: "application/json", "text/plain"
filtersobject | nullYes
created_atstringYes
updated_atstringYes
secretstringYesReturned only once, in the create and rotation responses.

Example response:

{
  "url": "https://pushizo.com/orders/1001",
  "events": [
    "purchase"
  ],
  "status": "active",
  "id": "whe_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "description": "Sipariş durumu güncellemeleri",
  "event_filters": {
    "event_names": [
      "purchase"
    ]
  },
  "batch": true,
  "disabled_reason": "örnek",
  "failure_count": 1,
  "failing_since": "örnek",
  "last_success_at": "örnek",
  "last_failure_at": "örnek",
  "header_names": [
    "örnek"
  ],
  "previous_secret_expires_at": "örnek",
  "body_template": "örnek",
  "body_content_type": "application/json",
  "filters": {
    "match": "all",
    "conditions": [
      {
        "field": "örnek",
        "op": "eq",
        "value": "user_42"
      }
    ]
  },
  "created_at": "örnek",
  "updated_at": "örnek",
  "secret": "örnek"
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/webhooks/whe_01JD3W5Q7X9K2M4N6P8R0T1V3W/rotate-secret" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Send a test event (immediate, returns the result)

POST/v1/apps/{appId}/webhooks/{webhookId}/testTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
webhookIdpathstringYes"whe_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WebhookDeliveryDetail

FieldTypeRequiredDescription
idstringYes
endpoint_idstringYes
event_typestringYes
event_idstringYes
subject_idstring | nullYes
attemptintegerYes
statusenumYesValues: "pending", "success", "failed", "dead"
response_statusinteger | nullYes
response_body_excerptstring | nullYes
errorstring | nullYes
duration_msinteger | nullYes
next_retry_atstring | nullYes
delivered_atstring | nullYes
replay_ofstring | nullYes
created_atstringYes
payloadmap<string, any>Yes

Example response:

{
  "status": "pending",
  "id": "dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "endpoint_id": "whe_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "event_type": "örnek",
  "event_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "subject_id": "dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "attempt": 1,
  "response_status": 1,
  "response_body_excerpt": "örnek",
  "error": "örnek",
  "duration_ms": 1,
  "next_retry_at": "örnek",
  "delivered_at": "örnek",
  "replay_of": "örnek",
  "created_at": "örnek",
  "payload": {
    "key": "örnek"
  }
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/webhooks/whe_01JD3W5Q7X9K2M4N6P8R0T1V3W/test" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Delivery history (cursor; status/event type filter)

GET/v1/apps/{appId}/webhooks/{webhookId}/deliveriesTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
webhookIdpathstringYes"whe_01JD3W5Q7X9K2M4N6P8R0T1V3W"
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
statusqueryenumNoValues: "pending", "success", "failed", "dead""pending"
event_typequerystringNoLength: 0–64"örnek"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WebhookDeliveryPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].endpoint_idstringYes
data[].event_typestringYes
data[].event_idstringYes
data[].subject_idstring | nullYes
data[].attemptintegerYes
data[].statusenumYesValues: "pending", "success", "failed", "dead"
data[].response_statusinteger | nullYes
data[].response_body_excerptstring | nullYes
data[].errorstring | nullYes
data[].duration_msinteger | nullYes
data[].next_retry_atstring | nullYes
data[].delivered_atstring | nullYes
data[].replay_ofstring | nullYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Example response:

{
  "data": [
    {
      "status": "pending",
      "id": "whe_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "endpoint_id": "whe_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "event_type": "örnek",
      "event_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "subject_id": "whe_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "attempt": 1,
      "response_status": 1,
      "response_body_excerpt": "örnek",
      "error": "örnek",
      "duration_ms": 1,
      "next_retry_at": "örnek",
      "delivered_at": "örnek",
      "replay_of": "örnek",
      "created_at": "örnek"
    }
  ],
  "next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
  "has_more": true
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/webhooks/whe_01JD3W5Q7X9K2M4N6P8R0T1V3W/deliveries?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Replay failed/dead deliveries in bulk (up to 1000)

POST/v1/apps/{appId}/webhooks/{webhookId}/replayTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
webhookIdpathstringYes"whe_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: BulkReplayDto

FieldTypeRequiredDescription
statusenumNoValues: "failed", "dead", "failed_or_dead"
fromstring (date-time)No
tostring (date-time)No

Example:

{
  "status": "failed",
  "from": "2026-10-17T09:00:00Z",
  "to": "2026-10-17T09:00:00Z"
}

Responses

200 — Success.

Schema: WebhookBulkReplayResult

FieldTypeRequiredDescription
replayedintegerYes

Example response:

{
  "replayed": 1
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/webhooks/whe_01JD3W5Q7X9K2M4N6P8R0T1V3W/replay" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "failed",
  "from": "2026-10-17T09:00:00Z",
  "to": "2026-10-17T09:00:00Z"
}'

Delivery details (including the payload)

GET/v1/apps/{appId}/webhooks/deliveries/{deliveryId}Try it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
deliveryIdpathstringYes"dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WebhookDeliveryDetail

FieldTypeRequiredDescription
idstringYes
endpoint_idstringYes
event_typestringYes
event_idstringYes
subject_idstring | nullYes
attemptintegerYes
statusenumYesValues: "pending", "success", "failed", "dead"
response_statusinteger | nullYes
response_body_excerptstring | nullYes
errorstring | nullYes
duration_msinteger | nullYes
next_retry_atstring | nullYes
delivered_atstring | nullYes
replay_ofstring | nullYes
created_atstringYes
payloadmap<string, any>Yes

Example response:

{
  "status": "pending",
  "id": "dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "endpoint_id": "whe_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "event_type": "örnek",
  "event_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "subject_id": "dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "attempt": 1,
  "response_status": 1,
  "response_body_excerpt": "örnek",
  "error": "örnek",
  "duration_ms": 1,
  "next_retry_at": "örnek",
  "delivered_at": "örnek",
  "replay_of": "örnek",
  "created_at": "örnek",
  "payload": {
    "key": "örnek"
  }
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/webhooks/deliveries/dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Redeliver (with the same event ID)

POST/v1/apps/{appId}/webhooks/deliveries/{deliveryId}/replayTry it (interactive API docs, new tab)

Authentication: API key — scope admin (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
deliveryIdpathstringYes"dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: WebhookDeliveryDetail

FieldTypeRequiredDescription
idstringYes
endpoint_idstringYes
event_typestringYes
event_idstringYes
subject_idstring | nullYes
attemptintegerYes
statusenumYesValues: "pending", "success", "failed", "dead"
response_statusinteger | nullYes
response_body_excerptstring | nullYes
errorstring | nullYes
duration_msinteger | nullYes
next_retry_atstring | nullYes
delivered_atstring | nullYes
replay_ofstring | nullYes
created_atstringYes
payloadmap<string, any>Yes

Example response:

{
  "status": "pending",
  "id": "dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "endpoint_id": "whe_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "event_type": "örnek",
  "event_id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "subject_id": "dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "attempt": 1,
  "response_status": 1,
  "response_body_excerpt": "örnek",
  "error": "örnek",
  "duration_ms": 1,
  "next_retry_at": "örnek",
  "delivered_at": "örnek",
  "replay_of": "örnek",
  "created_at": "örnek",
  "payload": {
    "key": "örnek"
  }
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/webhooks/deliveries/dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W/replay" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

On this page