Menu
Platform
AI
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Notifications
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Queues
Realtime
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Get a webhook delivery
Gets a webhook delivery.
Gets a webhook delivery.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint/webhook_deliveries/webhook-delivery - Scope
events:read - Effect
read— nothing is written. - Collection webhook_deliveries
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the webhook delivery to get. Required. |
#Response
| 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.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint/webhook_deliveries/webhook-delivery" \
-H "Authorization: Bearer $SYLPHX_API_KEY"