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
Details
Event types that can be subscribed to
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WebhookEventTypes
| Field | Type | Required | Description |
|---|---|---|---|
data | array<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
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WebhookList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].url | string | Yes | |
data[].description | string | null | Yes | |
data[].events | array<string> | Yes | |
data[].event_filters | object | Yes | |
data[].event_filters.event_names | array<string> | No | |
data[].batch | boolean | Yes | |
data[].status | enum | Yes | Values: "active", "failing", "disabled" |
data[].disabled_reason | string | null | Yes | |
data[].failure_count | integer | Yes | |
data[].failing_since | string | null | Yes | |
data[].last_success_at | string | null | Yes | |
data[].last_failure_at | string | null | Yes | |
data[].header_names | array<string> | Yes | |
data[].previous_secret_expires_at | string | null | Yes | |
data[].body_template | string | null | Yes | |
data[].body_content_type | enum | Yes | Values: "application/json", "text/plain" |
data[].filters | object | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
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)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CreateWebhookDto
| Field | Type | Required | Description |
|---|---|---|---|
url | string | Yes | Length: 1–2048 |
description | string | null | No | |
events | array<enum> | Yes | Items: 1–41 |
event_filters | object | No | |
event_filters.event_names | array<string> | No | Items: 0–50 |
batch | boolean | No | |
headers | map<string, string> | No | |
body_template | string | null | No | |
body_content_type | enum | No | Content type of the template output (default application/json).. Values: "application/json", "text/plain" |
filters | object | null | No |
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
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
url | string | Yes | |
description | string | null | Yes | |
events | array<string> | Yes | |
event_filters | object | Yes | |
event_filters.event_names | array<string> | No | |
batch | boolean | Yes | |
status | enum | Yes | Values: "active", "failing", "disabled" |
disabled_reason | string | null | Yes | |
failure_count | integer | Yes | |
failing_since | string | null | Yes | |
last_success_at | string | null | Yes | |
last_failure_at | string | null | Yes | |
header_names | array<string> | Yes | |
previous_secret_expires_at | string | null | Yes | |
body_template | string | null | Yes | |
body_content_type | enum | Yes | Values: "application/json", "text/plain" |
filters | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
secret | string | Yes | Returned 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)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: WebhookPreviewDto
| Field | Type | Required | Description |
|---|---|---|---|
event_type | enum | Yes | Values: "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" |
data | map<string, any> | No | |
body_template | string | null | No | |
body_content_type | enum | No | Content type of the template output (default application/json).. Values: "application/json", "text/plain" |
filters | object | null | No | |
batch | boolean | No |
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
| Field | Type | Required | Description |
|---|---|---|---|
payload | map<string, any> | Yes | |
matched | boolean | Yes | Whether the event passes the filter (if not, it is not sent). |
failed_conditions | array<object> | Yes | |
failed_conditions[].field | string | Yes | |
failed_conditions[].op | string | Yes | |
failed_conditions[].value | any | No | |
body | string | null | Yes | |
content_type | string | Yes | |
error | object | null | Yes |
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
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
webhookId | path | string | Yes | "whe_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Webhook
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
url | string | Yes | |
description | string | null | Yes | |
events | array<string> | Yes | |
event_filters | object | Yes | |
event_filters.event_names | array<string> | No | |
batch | boolean | Yes | |
status | enum | Yes | Values: "active", "failing", "disabled" |
disabled_reason | string | null | Yes | |
failure_count | integer | Yes | |
failing_since | string | null | Yes | |
last_success_at | string | null | Yes | |
last_failure_at | string | null | Yes | |
header_names | array<string> | Yes | |
previous_secret_expires_at | string | null | Yes | |
body_template | string | null | Yes | |
body_content_type | enum | Yes | Values: "application/json", "text/plain" |
filters | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
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)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
webhookId | path | string | Yes | "whe_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateWebhookDto
| Field | Type | Required | Description |
|---|---|---|---|
url | string | No | Length: 1–2048 |
description | string | null | No | |
events | array<enum> | No | Items: 1–41 |
event_filters | object | No | |
event_filters.event_names | array<string> | No | Items: 0–50 |
batch | boolean | No | |
headers | map<string, string> | null | No | |
status | enum | No | Values: "active", "disabled" |
body_template | string | null | No | |
body_content_type | enum | No | Content type of the template output (default application/json).. Values: "application/json", "text/plain" |
filters | object | null | No |
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
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
url | string | Yes | |
description | string | null | Yes | |
events | array<string> | Yes | |
event_filters | object | Yes | |
event_filters.event_names | array<string> | No | |
batch | boolean | Yes | |
status | enum | Yes | Values: "active", "failing", "disabled" |
disabled_reason | string | null | Yes | |
failure_count | integer | Yes | |
failing_since | string | null | Yes | |
last_success_at | string | null | Yes | |
last_failure_at | string | null | Yes | |
header_names | array<string> | Yes | |
previous_secret_expires_at | string | null | Yes | |
body_template | string | null | Yes | |
body_content_type | enum | Yes | Values: "application/json", "text/plain" |
filters | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
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
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
webhookId | path | string | Yes | "whe_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Ok
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes |
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)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
webhookId | path | string | Yes | "whe_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WebhookWithSecret
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
url | string | Yes | |
description | string | null | Yes | |
events | array<string> | Yes | |
event_filters | object | Yes | |
event_filters.event_names | array<string> | No | |
batch | boolean | Yes | |
status | enum | Yes | Values: "active", "failing", "disabled" |
disabled_reason | string | null | Yes | |
failure_count | integer | Yes | |
failing_since | string | null | Yes | |
last_success_at | string | null | Yes | |
last_failure_at | string | null | Yes | |
header_names | array<string> | Yes | |
previous_secret_expires_at | string | null | Yes | |
body_template | string | null | Yes | |
body_content_type | enum | Yes | Values: "application/json", "text/plain" |
filters | object | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
secret | string | Yes | Returned 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)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
webhookId | path | string | Yes | "whe_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WebhookDeliveryDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
endpoint_id | string | Yes | |
event_type | string | Yes | |
event_id | string | Yes | |
subject_id | string | null | Yes | |
attempt | integer | Yes | |
status | enum | Yes | Values: "pending", "success", "failed", "dead" |
response_status | integer | null | Yes | |
response_body_excerpt | string | null | Yes | |
error | string | null | Yes | |
duration_ms | integer | null | Yes | |
next_retry_at | string | null | Yes | |
delivered_at | string | null | Yes | |
replay_of | string | null | Yes | |
created_at | string | Yes | |
payload | map<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)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
webhookId | path | string | Yes | "whe_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
limit | query | integer | No | Default: 50; Range: 1–200 | 50 |
cursor | query | string | No | Length: 1–∞ | "eyJpZCI6Im1zZ18wMUpE…" |
status | query | enum | No | Values: "pending", "success", "failed", "dead" | "pending" |
event_type | query | string | No | Length: 0–64 | "örnek" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WebhookDeliveryPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].endpoint_id | string | Yes | |
data[].event_type | string | Yes | |
data[].event_id | string | Yes | |
data[].subject_id | string | null | Yes | |
data[].attempt | integer | Yes | |
data[].status | enum | Yes | Values: "pending", "success", "failed", "dead" |
data[].response_status | integer | null | Yes | |
data[].response_body_excerpt | string | null | Yes | |
data[].error | string | null | Yes | |
data[].duration_ms | integer | null | Yes | |
data[].next_retry_at | string | null | Yes | |
data[].delivered_at | string | null | Yes | |
data[].replay_of | string | null | Yes | |
data[].created_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
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)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
webhookId | path | string | Yes | "whe_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: BulkReplayDto
| Field | Type | Required | Description |
|---|---|---|---|
status | enum | No | Values: "failed", "dead", "failed_or_dead" |
from | string (date-time) | No | |
to | string (date-time) | No |
Example:
{
"status": "failed",
"from": "2026-10-17T09:00:00Z",
"to": "2026-10-17T09:00:00Z"
}Responses
200 — Success.
Schema: WebhookBulkReplayResult
| Field | Type | Required | Description |
|---|---|---|---|
replayed | integer | Yes |
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)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
deliveryId | path | string | Yes | "dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WebhookDeliveryDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
endpoint_id | string | Yes | |
event_type | string | Yes | |
event_id | string | Yes | |
subject_id | string | null | Yes | |
attempt | integer | Yes | |
status | enum | Yes | Values: "pending", "success", "failed", "dead" |
response_status | integer | null | Yes | |
response_body_excerpt | string | null | Yes | |
error | string | null | Yes | |
duration_ms | integer | null | Yes | |
next_retry_at | string | null | Yes | |
delivered_at | string | null | Yes | |
replay_of | string | null | Yes | |
created_at | string | Yes | |
payload | map<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)
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
deliveryId | path | string | Yes | "dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WebhookDeliveryDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
endpoint_id | string | Yes | |
event_type | string | Yes | |
event_id | string | Yes | |
subject_id | string | null | Yes | |
attempt | integer | Yes | |
status | enum | Yes | Values: "pending", "success", "failed", "dead" |
response_status | integer | null | Yes | |
response_body_excerpt | string | null | Yes | |
error | string | null | Yes | |
duration_ms | integer | null | Yes | |
next_retry_at | string | null | Yes | |
delivered_at | string | null | Yes | |
replay_of | string | null | Yes | |
created_at | string | Yes | |
payload | map<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"Dynamic Content and Data Feeds
Dynamic Content and Data Feeds — 34 operations (GET /v1/apps/{appId}/data-feeds, POST /v1/apps/{appId}/data-feeds, GET /v1/apps/{appId}/data-feeds/{feedId}, …). Generated from the OpenAPI 3.1.0 contract.
Analytics
Analytics — 54 operations (GET /v1/apps/{appId}/rfm/config, PUT /v1/apps/{appId}/rfm/config, POST /v1/apps/{appId}/rfm/compute, …). Generated from the OpenAPI 3.1.0 contract.