Баримт бичиг / API лавлах
Вебхүүк
Гарын үсэгтэй үйл явдал хүлээн авах эндпойнт.
GET/v1/workspaces/{workspaceId}/webhooks
List the workspace's webhook endpoints.
Шаардлагатай API түлхүүрийн хамрах хүрээ: webhooks.read
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
page | query | integer (int32) | | |
pageSize | query | integer (int32) | | |
Хариу: 200 WebhookDto[]
POST/v1/workspaces/{workspaceId}/webhooks
Create an endpoint (Business and above). The signing secret is in the response.
Шаардлагатай API түлхүүрийн хамрах хүрээ: webhooks.write
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хүсэлтийн бие (NewWebhook)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
name | string | тийм | 1-190 characters. |
url | string | тийм | https URL on a public DNS name. |
events | string[] | тийм | Event types, see `GET .../webhooks/events`. |
linkScope | null | LinkScope | | |
click | null | ClickOptions | | |
apiVersion | string | | Payload version; only `2026-11-01` exists. |
Хариу: 201 WebhookCreated
GET/v1/workspaces/{workspaceId}/webhooks/events
The event catalogue with descriptions, plan and sample payloads.
Шаардлагатай API түлхүүрийн хамрах хүрээ: webhooks.read
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хариу: 200 EventInfo[]
GET/v1/workspaces/{workspaceId}/webhooks/ips
Published egress addresses of the delivery workers.
Шаардлагатай API түлхүүрийн хамрах хүрээ: webhooks.read
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хариу: 200 EgressIps
GET/v1/workspaces/{workspaceId}/webhooks/{webhookId}
One endpoint.
Шаардлагатай API түлхүүрийн хамрах хүрээ: webhooks.read
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
webhookId | path | string | тийм | |
Хариу: 200 WebhookDto
PATCH/v1/workspaces/{workspaceId}/webhooks/{webhookId}
Update an endpoint. A new URL re-runs every URL rule and the DNS check; changes apply to events fanned out after the commit.
Шаардлагатай API түлхүүрийн хамрах хүрээ: webhooks.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
webhookId | path | string | тийм | |
Хүсэлтийн бие (UpdateWebhook)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
name | string | | |
url | string | | |
events | array | | |
linkScope | null | LinkScope | | |
click | null | ClickOptions | | |
apiVersion | string | | |
Хариу: 200 WebhookDto
DELETE/v1/workspaces/{workspaceId}/webhooks/{webhookId}
Delete an endpoint; its log becomes unreachable.
Шаардлагатай API түлхүүрийн хамрах хүрээ: webhooks.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
webhookId | path | string | тийм | |
Хариу: 200 DeletedId
GET/v1/workspaces/{workspaceId}/webhooks/{webhookId}/deliveries
Delivery log of an endpoint, newest first (30 days).
Шаардлагатай API түлхүүрийн хамрах хүрээ: webhooks.read
Параметр (11)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
webhookId | path | string | тийм | |
pageSize | query | integer (int32) | | |
startingAfter | query | string | | |
endingBefore | query | string | | |
status | query | string | | |
eventType | query | string | | |
eventId | query | string | | |
from | query | string (date-time) | | |
to | query | string (date-time) | | |
isTest | query | boolean | | |
Хариу: 200 DeliveryDto[]
POST/v1/workspaces/{workspaceId}/webhooks/{webhookId}/deliveries/redeliver-failed
Redeliver every failed delivery of a time window (max 7 days, 1,000 deliveries; a job).
Шаардлагатай API түлхүүрийн хамрах хүрээ: webhooks.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
webhookId | path | string | тийм | |
Хүсэлтийн бие (RedeliverWindow)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
from | string (date-time) | тийм | |
to | string (date-time) | тийм | |
Хариу: 202 Queued
GET/v1/workspaces/{workspaceId}/webhooks/{webhookId}/deliveries/{deliveryId}
One delivery with its frozen payload and every attempt.
Шаардлагатай API түлхүүрийн хамрах хүрээ: webhooks.read
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
webhookId | path | string | тийм | |
deliveryId | path | string | тийм | |
Хариу: 200 DeliveryDetail
POST/v1/workspaces/{workspaceId}/webhooks/{webhookId}/deliveries/{deliveryId}/redeliver
Redeliver one logged delivery: a new delivery of the same event id with the stored payload, the endpoint's current URL and secret.
Шаардлагатай API түлхүүрийн хамрах хүрээ: webhooks.write
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
webhookId | path | string | тийм | |
deliveryId | path | string | тийм | |
Хариу: 202 DeliveryDto
POST/v1/workspaces/{workspaceId}/webhooks/{webhookId}/disable
Disable an endpoint by hand: it receives nothing and no backlog builds up.
Шаардлагатай API түлхүүрийн хамрах хүрээ: webhooks.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
webhookId | path | string | тийм | |
Хариу: 200 WebhookDto
POST/v1/workspaces/{workspaceId}/webhooks/{webhookId}/enable
Re-enable an endpoint: resets the failure counters.
Шаардлагатай API түлхүүрийн хамрах хүрээ: webhooks.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
webhookId | path | string | тийм | |
Хүсэлтийн бие (EnableBody)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
redeliverFailedLast24h | boolean | | Create new deliveries for failed deliveries of the last 24 hours (max 1,000). |
Хариу: 200 WebhookDto
POST/v1/workspaces/{workspaceId}/webhooks/{webhookId}/rotate-secret
Rotate the signing secret: the new one signs at once, the previous one keeps signing alongside it for the grace period.
Шаардлагатай API түлхүүрийн хамрах хүрээ: webhooks.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
webhookId | path | string | тийм | |
Хүсэлтийн бие (RotateBody)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
graceHours | integer (int32) | | Hours the previous secret keeps signing too, 0-72 (default 24, rule 14). |
Хариу: 200 Rotated
GET/v1/workspaces/{workspaceId}/webhooks/{webhookId}/secret
Reveal the signing secret (owners, signed-in sessions only; audit-logged, rule 13).
Шаардлагатай API түлхүүрийн хамрах хүрээ: webhooks.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
webhookId | path | string | тийм | |
Хариу: 200 SecretBody
GET/v1/workspaces/{workspaceId}/webhooks/{webhookId}/stats
Hourly counters of the last 30 days.
Шаардлагатай API түлхүүрийн хамрах хүрээ: webhooks.read
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
webhookId | path | string | тийм | |
Хариу: 200 StatsPoint[]
POST/v1/workspaces/{workspaceId}/webhooks/{webhookId}/test
Send a synthetic sample of an event through the real engine: test: true, Az-Test: 1, one attempt, no effect on the failure counter.
Шаардлагатай API түлхүүрийн хамрах хүрээ: webhooks.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
webhookId | path | string | тийм | |
Хүсэлтийн бие (TestBody)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
event | string | тийм | Event type to send a sample of. |
Хариу: 202 TestQueued