Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Create an inbound endpoint
Creates an inbound endpoint.
This method is not served on the public API.
api.sylphx.comdoes not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.
Creates an inbound endpoint.
- Path
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/inbound_endpoints - Scope
events:write - Effect
write— a successful call changes state. - Collection inbound_endpoints
- Query
inbound_endpoint_id,validate_only
#Request
| Field | Type | What it is |
|---|---|---|
parent | string | The parent to create in. Required. |
inbound_endpoint_id | string | The inbound endpoint id, the final name segment; the server assigns one when empty. |
inbound_endpoint | InboundEndpoint | The inbound endpoint to create; only caller-writable fields are read. Required. |
validate_only | bool | Validate and return the result without writing anything. |
#InboundEndpoint
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/inbound_endpoints/{inbound_endpoint}. |
meta | ResourceMeta | Resource metadata. |
spec | InboundEndpointSpec | Desired state. Required. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
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. |
#InboundEndpointSpec
| Field | Type | What it is |
|---|---|---|
signature_scheme | InboundSignatureScheme | The sender's signature scheme. Required. One of standard_webhooks, stripe, shopify, github. |
verification_secret | string | The provider's verification secret, held in Sylphx Secrets. Required. |
topic | string | The Topic verified requests are published to. Required. |
source | string | The CloudEvents source of published events; default the endpoint name. |
#Response
| 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. |
#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. |
#InboundEndpointSpec
| Field | Type | What it is |
|---|---|---|
signature_scheme | InboundSignatureScheme | The sender's signature scheme. Required. One of standard_webhooks, stripe, shopify, github. |
verification_secret | string | The provider's verification secret, held in Sylphx Secrets. Required. |
topic | string | The Topic verified requests are published to. Required. |
source | string | The CloudEvents source of published events; default the endpoint name. |
#InboundEndpointStatus
| Field | Type | What it is |
|---|---|---|
observed_generation | int64 | The generation this status was computed from. Output only. |
conditions | Condition[] | Ready, Reconciling, Stalled. Output only. |
receive_uri | string | The URI to give the provider. Output only. |
last_receive_time | timestamp | The last verified request. Output only. |
rejected_count | int64 | Requests refused for a bad signature, all time. Output only. |
#Condition
| Field | Type | What it is |
|---|---|---|
type | string | The condition type, for example Ready. |
status | ConditionStatus | Whether the condition holds. One of true, false, unknown. |
observed_generation | int64 | The generation this observation was made against. |
reason | string | A machine-readable UpperCamelCase reason. |
message | string | A customer-safe human-readable message. |
severity | Severity | How severe a FALSE condition is. One of info, warning, error. |
transition_time | timestamp | When status last changed. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.UNKNOWN_FIELD— The request has a field the schema does not know.INVALID_FIELD— A field failed validation.RESOURCE_ALREADY_EXISTS— A Resource with this name exists.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.IDEMPOTENCY_IN_PROGRESS— The first call with this Idempotency-Key is still running.PLAN_LIMIT_REACHED— The plan's limit is reached.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/inbound_endpoints" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"spec":{"signature_scheme":"standard_webhooks","topic":"…","verification_secret":"…"}}'