Skip to content
Console
On this page

Create a webhook endpoint

Creates a webhook endpoint.

Creates a webhook endpoint.

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints
  • Scope events:write
  • Effect write — a successful call changes state.
  • Collection webhook_endpoints
  • Query webhook_endpoint_id, validate_only

Request

FieldTypeWhat it is
parentstringThe parent to create in. Required.
webhook_endpoint_idstringThe webhook endpoint id, the final name segment; the server assigns one when empty.
webhook_endpointWebhookEndpointThe webhook endpoint to create; only caller-writable fields are read. Required.
validate_onlyboolValidate and return the result without writing anything.

WebhookEndpoint

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/webhook_endpoints/{webhook_endpoint}.
metaResourceMetaResource metadata.
specWebhookEndpointSpecDesired state. Required.

ResourceMeta

FieldTypeWhat it is
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.

WebhookEndpointSpec

FieldTypeWhat it is
uristringThe HTTPS URI deliveries are POSTed to; its host resolves to a public address. Required.
disabledboolStop delivering; deliveries queue until enabled.
max_concurrent_deliveriesint32At most this many deliveries in flight; default 10.
event_typesstring[]Which event types the endpoint receives: an exact type (order.paid), a prefix ending in .* (order.*), or * for every type; default ["*"].
rate_limit_per_secondint32At most this many attempts start per second; 0 is no limit. Deliveries over the limit wait their turn; none is dropped.
consumerstringOptional opaque customer identifier. A nonempty value receives only events whose CloudEvents consumer extension is the same string. Empty receives every consumer, including events without the extension.

Response

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/webhook_endpoints/{webhook_endpoint}.
uidstringwhe_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specWebhookEndpointSpecDesired state. Required.
statusWebhookEndpointStatusObserved state. 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.

WebhookEndpointSpec

FieldTypeWhat it is
uristringThe HTTPS URI deliveries are POSTed to; its host resolves to a public address. Required.
disabledboolStop delivering; deliveries queue until enabled.
max_concurrent_deliveriesint32At most this many deliveries in flight; default 10.
event_typesstring[]Which event types the endpoint receives: an exact type (order.paid), a prefix ending in .* (order.*), or * for every type; default ["*"].
rate_limit_per_secondint32At most this many attempts start per second; 0 is no limit. Deliveries over the limit wait their turn; none is dropped.
consumerstringOptional opaque customer identifier. A nonempty value receives only events whose CloudEvents consumer extension is the same string. Empty receives every consumer, including events without the extension.

WebhookEndpointStatus

FieldTypeWhat it is
observed_generationint64The generation this status was computed from. Output only.
conditionsCondition[]Ready, Reconciling, Stalled. Output only.
stateWebhookEndpointStateWhether Events is delivering. Output only. One of enabled, disabled, failing_disabled.
disable_reasonstringWhy Events disabled the endpoint, when it did. Output only.
last_success_timetimestampThe last 2xx answer. Output only.
consecutive_failure_countint32Consecutive failed delivery attempts since the last 2xx. Output only.
signing_secretstringThe Standard Webhooks signing secret (whsec_…). Set only in the answer of CreateWebhookEndpoint and RotateWebhookEndpointSecret; every other read leaves it empty, and Events never shows it again. Output only. Never returned again.
previous_secret_expire_timetimestampAfter a rotation, deliveries carry a second signature with the previous secret until this time. Output only.

Condition

FieldTypeWhat it is
typestringThe condition type, for example Ready.
statusConditionStatusWhether the condition holds. One of true, false, unknown.
observed_generationint64The generation this observation was made against.
reasonstringA machine-readable UpperCamelCase reason.
messagestringA customer-safe human-readable message.
severitySeverityHow severe a FALSE condition is. One of info, warning, error.
transition_timetimestampWhen status last changed.

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" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"spec":{"uri":"…"}}'