Inbound endpoints
An Inbound Endpoint receives a provider's webhooks.
An Inbound Endpoint receives a provider's webhooks. Events verifies the provider signature with a secret in Sylphx Secrets, dedupes by the provider's delivery id, answers 2xx inside the provider's budget, persists the raw request, then publishes it onto a Topic. A bad signature is refused and recorded.
Service Sylphx Events · Resource type events.sylphx.com/InboundEndpoint · Name pattern orgs/{org}/projects/{project}/envs/{env}/inbound_endpoints/{inbound_endpoint} · Shape spec_status
Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/inbound_endpoints/{inbound_endpoint}. |
uid | string | ibe_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | InboundEndpointSpec | Desired state. Required. |
status | InboundEndpointStatus | Observed state. Output only. |
Methods
Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets an inbound endpoint. |
GET | list | Lists inbound endpoints. |
POST | create | Creates an inbound endpoint. |
PATCH | update | Updates an inbound endpoint. |
DELETE | delete | Deletes an inbound endpoint. |
get
Gets an 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.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/inbound_endpoints · scope events:read · effect read · paginated · Request, response and examples
create
Creates an inbound endpoint.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/inbound_endpoints · scope events:write · effect write · Request, response and examples
update
Updates an inbound endpoint.
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
delete
Deletes an inbound endpoint.
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