Skip to content
Console
On this page

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

FieldTypeWhat it is
namestringThe name of the webhook endpoint. Required.

Response

FieldTypeWhat it is
webhook_deliveryWebhookDeliveryThe delivery of the test event; read it back for its attempts.

WebhookDelivery

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/webhook_endpoints/{webhook_endpoint}/webhook_deliveries/{webhook_delivery}.
uidstringwhd_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
eventstringThe retained Event delivered. Unset when its admission environment is unknown, differs from the endpoint's environment, or the Event is gone. Output only.
subscriptionstringThe sole retained Subscription association. Unset when zero or multiple Subscriptions share this delivery; use subscriptions for the complete set. Output only.
stateDeliveryStateThe delivery state. Output only. One of pending, delivered, dead_lettered, cancelled.
attemptsDeliveryAttempt[]Every attempt, oldest first. Output only.
next_attempt_timetimestampWhen the next attempt is due. Output only.
event_typestringThe CloudEvents type of the event delivered. Output only.
subscriptionsstring[]Every retained Subscription association in the endpoint's environment, ordered by resource name. Direct and test deliveries can have none. Output only.

ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong 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_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

DeliveryAttempt

FieldTypeWhat it is
attempt_numberint32The attempt number, from 1. Output only.
outcomeDeliveryAttemptOutcomeHow the attempt ended. Output only. One of delivered, retryable_failure, terminal_failure, ambiguous.
http_statusint32The endpoint's HTTP status, when it answered. Output only.
error_codestringA machine-readable failure code. Output only.
start_timetimestampWhen the attempt started. Output only.
end_timetimestampWhen the attempt ended. Output only.
evidence_digeststringsha256:<hex> of the recorded response evidence. Output only.

Errors

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 '{}'