Start

Platform

App store purchases

Auth

Builds

Database

Flags

Generated Assets

Assets

Hosting

Jobs and cron

Localization

Monitoring

Network

Notifications

Organizations

Payments

Queues

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

Reference

sylphx events inbound_endpoints

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

Checked 2026-09-28

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

#get

Gets an inbound endpoint.

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

CLI

Shell

sylphx events inbound-endpoints get orgs/acme/projects/shop/envs/production/inbound_endpoints/inbound-endpoint

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

#list

Lists inbound 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 inbound-endpoints list orgs/acme/projects/shop/envs/production

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/inbound_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 an inbound endpoint.

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

CLI

Shell

sylphx events inbound-endpoints create --parent orgs/acme/projects/shop/envs/production --spec.signature-scheme standard_webhooks --spec.verification-secret … --spec.topic …

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/inbound_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.signature-scheme`	`enum`	The sender's signature scheme. Required. One of `standard_webhooks`, `stripe`, `shopify`, `github`.
`--spec.verification-secret`	`string`	The provider's verification secret, held in Sylphx Secrets. Required.
`--spec.topic`	`string`	The Topic verified requests are published to. Required.
`--spec.source`	`string`	The CloudEvents `source` of published events; default the endpoint name.
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).

#update

Updates an inbound endpoint.

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

CLI

Shell

sylphx events inbound-endpoints update orgs/acme/projects/shop/envs/production/inbound_endpoints/inbound-endpoint --spec.signature-scheme standard_webhooks --spec.verification-secret … --spec.topic …

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/inbound_endpoints/inbound-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.signature-scheme`	`enum`	The sender's signature scheme. Required. One of `standard_webhooks`, `stripe`, `shopify`, `github`.
`--spec.verification-secret`	`string`	The provider's verification secret, held in Sylphx Secrets. Required.
`--spec.topic`	`string`	The Topic verified requests are published to. Required.
`--spec.source`	`string`	The CloudEvents `source` of published events; default the endpoint name.
`--allow-missing`	`bool`	Create the inbound endpoint when it does not exist (declarative upsert).
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).

#delete

Deletes an inbound endpoint.

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

CLI

Shell

sylphx events inbound-endpoints delete orgs/acme/projects/shop/envs/production/inbound_endpoints/inbound-endpoint --yes

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/inbound_endpoints/inbound-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 inbound endpoint does not exist.
`--dry-run`	`bool`	Validate and print the result without writing (validate_only).
`--yes`	`bool`	Do not ask before this destructive call.

Was this page helpful?

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

Send feedback

Platform links