Start

Platform

App store purchases

Auth

Builds

Database

Flags

Hosting

Jobs and cron

Localization

Monitoring

Network

Notifications

Organizations

Payments

Queues

Events

Realtime

Runners

Sandboxes

Storage

Webhooks

Workflows

Getting Started

Installation

Authentication

AI Services

KV Store

Overview

Webhooks

Deploy & Infrastructure

Reference

On this page

get
list
create
update
delete
replay
rotate-secret
test

Reference

sylphx events webhook_endpoints

Every sylphx events webhook_endpoints command: its argument, its flags and a run line.

Checked 2026-09-28

The webhook_endpoints commands of Sylphx Events, as the CLI spells them: the same calls as the webhook_endpoints API page, typed for the shell. Install, sign in and the grammar are on the CLI index.

#get

Gets a webhook endpoint.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell

sylphx events webhook-endpoints get orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint · scope events:read · effect read · Request, response and examples

#list

Lists webhook endpoints.

PARENT — optional: the CLI fills it from the linked project or the key's scope when it is left out.

CLI

Shell

sylphx events webhook-endpoints list orgs/acme/projects/shop/envs/production

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints · scope events:read · effect read · Request, response and examples

Flags

Flag	Type	What it does
`--page-size`	`int`	At most this many; default 50, clamped to 1000.
`--page-token`	`string`	`next_page_token` of the previous page.
`--filter`	`string`	AIP-160 filter over labels and filterable fields.
`--order-by`	`string`	AIP-132 ordering over filterable fields.

#create

Creates a webhook endpoint.

ID — The id segment of the new Resource's name; the server assigns one when omitted.

CLI

Shell

sylphx events webhook-endpoints create --parent orgs/acme/projects/shop/envs/production --spec.uri …

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints · scope events:write · effect write · Request, response and examples

Flags

Flag	Type	What it does
`--parent`	`string`	The parent to create in; defaults to the linked project or the key's scope.
`--meta.labels`	`key=value`	Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
`--meta.annotations`	`key=value`	Caller-writable, unindexed annotations. Repeat the flag for each value.
`--meta.display-name`	`string`	Caller-writable human-readable name.
`--spec.uri`	`string`	The HTTPS URI deliveries are POSTed to; its host resolves to a public address. Required.
`--spec.disabled`	`bool`	Stop delivering; deliveries queue until enabled.
`--spec.max-concurrent-deliveries`	`int`	At most this many deliveries in flight; default 10.
`--spec.event-types`	`string`	Which event types the endpoint receives: an exact type (`order.paid`), a prefix ending in `.` (`order.`), or `` for every type; default `[""]`. Repeat the flag for each value.
`--spec.rate-limit-per-second`	`int`	At most this many attempts start per second; 0 is no limit. Deliveries over the limit wait their turn; none is dropped.
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).

#update

Updates a webhook endpoint.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell

sylphx events webhook-endpoints update orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint --spec.uri …

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint · scope events:write · effect write · Request, response and examples

Flags

Flag	Type	What it does
`--meta.labels`	`key=value`	Caller-writable, indexed labels (AIP-122 label rules). Repeat the flag for each value.
`--meta.annotations`	`key=value`	Caller-writable, unindexed annotations. Repeat the flag for each value.
`--meta.display-name`	`string`	Caller-writable human-readable name.
`--spec.uri`	`string`	The HTTPS URI deliveries are POSTed to; its host resolves to a public address. Required.
`--spec.disabled`	`bool`	Stop delivering; deliveries queue until enabled.
`--spec.max-concurrent-deliveries`	`int`	At most this many deliveries in flight; default 10.
`--spec.event-types`	`string`	Which event types the endpoint receives: an exact type (`order.paid`), a prefix ending in `.` (`order.`), or `` for every type; default `[""]`. Repeat the flag for each value.
`--spec.rate-limit-per-second`	`int`	At most this many attempts start per second; 0 is no limit. Deliveries over the limit wait their turn; none is dropped.
`--allow-missing`	`bool`	Create the webhook endpoint when it does not exist (declarative upsert).
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).

#delete

Deletes a webhook endpoint.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell

sylphx events webhook-endpoints delete orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint --yes

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint · scope events:write · effect destructive · Request, response and examples

Flags

Flag	Type	What it does
`--etag`	`string`	Delete only if the current etag matches.
`--allow-missing`	`bool`	Succeed when the webhook endpoint does not exist.
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).
`--force`	`bool`	Also delete the endpoint's delivery records and the Subscriptions that target it.
`--yes`	`bool`	Do not ask before this destructive call.

#replay

Redelivers every dead-lettered delivery to the endpoint created in a time range, each as a new attempt.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell

sylphx events webhook-endpoints replay orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint:replay · scope events:write · effect write · Request, response and examples

Flags

Flag	Type	What it does
`--start-time`	`timestamp`	Replay deliveries created at or after this time. Required.
`--end-time`	`timestamp`	Replay deliveries created before this time; default now.

#rotate-secret

Replaces the endpoint's signing secret and returns the new one, once (status.signing_secret). For 24 hours deliveries carry a signature with each secret, so a receiver can switch without dropping one.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell

sylphx events webhook-endpoints rotate-secret orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint:rotateSecret · scope events:write · effect write · Request, response and examples

Flags

Flag	Type	What it does
`--etag`	`string`	Rotate only if the current etag matches.

#test

Sends a test event (type sylphx.webhook.test) to the endpoint alone, through the same signing, retries, and delivery log as any other event.

NAME — the resource's name; a bare id is enough below the linked project.

CLI

Shell

sylphx events webhook-endpoints test orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint:test · scope events:write · effect write · Request, response and examples

Was this page helpful?

Tell us what is missing, wrong, or unclear — this opens a real inbox.

Send feedback

Platform links