Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Test a webhook endpoint
Sends a test event (`type` `sylphx.webhook.test`) to the endpoint alone, through the same signing, retries, and delivery log as any other…
Sends a test event (type sylphx.webhook.test) to the endpoint alone, through the same signing, retries, and delivery log as any other event.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint:test - Scope
events:write - Effect
write— a successful call changes state. - Collection webhook_endpoints
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the webhook endpoint. Required. |
#Response
| Field | Type | What it is |
|---|---|---|
webhook_delivery | WebhookDelivery | The delivery of the test event; read it back for its attempts. |
#WebhookDelivery
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/webhook_endpoints/{webhook_endpoint}/webhook_deliveries/{webhook_delivery}. |
uid | string | whd_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
event | string | The Event delivered. Output only. |
subscription | string | The Subscription that fanned it out. Output only. |
state | DeliveryState | The delivery state. Output only. One of pending, delivered, dead_lettered, cancelled. |
attempts | DeliveryAttempt[] | Every attempt, oldest first. Output only. |
next_attempt_time | timestamp | When the next attempt is due. Output only. |
event_type | string | The CloudEvents type of the event delivered. Output only. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#DeliveryAttempt
| Field | Type | What it is |
|---|---|---|
attempt_number | int32 | The attempt number, from 1. Output only. |
outcome | DeliveryAttemptOutcome | How the attempt ended. Output only. One of delivered, retryable_failure, terminal_failure, ambiguous. |
http_status | int32 | The endpoint's HTTP status, when it answered. Output only. |
error_code | string | A machine-readable failure code. Output only. |
start_time | timestamp | When the attempt started. Output only. |
end_time | timestamp | When the attempt ended. Output only. |
evidence_digest | string | sha256:<hex> of the recorded response evidence. Output only. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.INVALID_STATE— The Resource is in a state that forbids the call.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint:test" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'