Menu
Platform
AI
Analytics
App store purchases
Credits
Database
Flags
Generated Assets
Monitoring
Organizations
Payments
- Payments
- Payments quickstart
- Checkout policies
- Checkout sessions
- Customer subscriptions
- Entitlement grants
- Exchange rates
- Licence keys
- Licence tokens
- Merchant accounts
- Portal sessions
- Price catalogs
- Revenue
- Revenue facts
- Revenue sources
- Tax threshold statuses
- Usage events
- Usage invoices
- Usage meter prices
- Usage meters
- Usage reservations
- Usage settings
- Usage tiers
Queues
Realtime
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Publish service event on an event
Publishes a service's own event into a consenting tenant environment.
Publishes a service's own event into a consenting tenant environment. Requires events:publish and the exact events:platform:<service> scope. A webhook_uri selects exactly one registered endpoint in that environment; admission atomically stores its signed, retried delivery, or stores nothing.
- Path
POST https://api.sylphx.com/v1/events:publishServiceEvent - Scope
events:publish - Effect
write— a successful call changes state. - Collection events
#Request
| Field | Type | What it is |
|---|---|---|
parent | string | The consenting tenant environment: orgs/{org}/projects/{project}/envs/{env}. Required. |
event | CloudEvent | source must be sylphx.<service> and type must start with <service>. Required. |
webhook_uri | string | Exact registered https endpoint URI; empty uses ordinary environment fan-out. |
#CloudEvent
| Field | Type | What it is |
|---|---|---|
id | string | Unique per source; with source it is the dedupe key. Required. |
source | string | The producer's URI-reference. Required. |
type | string | The event type, for example com.example.order.created. Required. |
subject | string | The subject within the source. |
event_time | timestamp | When the occurrence happened. |
data_content_type | string | The payload media type; default application/json. |
data_schema | string | The payload schema URI. |
data | value | The payload. |
extensions | map<string, string> | Extension attributes, at most 64. |
#Response
| Field | Type | What it is |
|---|---|---|
event | Event | The stored tenant event. Output only. |
webhook_deliveries | string[] | Ordinary delivery resource names; read them to observe receiver acceptance. Output only. |
#Event
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/events/{event}. |
uid | string | evt_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
topic | string | The Topic it was published to. Output only. |
source | string | The producer's CloudEvents source. Output only. |
event_id | string | The producer's CloudEvents id, unique per source. Output only. |
type | string | The CloudEvents type. Output only. |
subject | string | The CloudEvents subject. Output only. |
event_time | timestamp | The CloudEvents time. Output only. |
data_content_type | string | The CloudEvents datacontenttype. Output only. |
data_schema | string | The CloudEvents dataschema. Output only. |
data | value | The payload. Output only. |
extensions | map<string, string> | CloudEvents extension attributes. Output only. |
admit_time | timestamp | When Events admitted it. 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. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.RESOURCE_ALREADY_EXISTS— A Resource with this name exists.IDEMPOTENCY_KEY_REUSED— An Idempotency-Key was reused with another body.
Every error arrives in the body Errors describes.
#Examples
curl -X POST "https://api.sylphx.com/v1/events:publishServiceEvent" \
-H "Authorization: Bearer $SYLPHX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"event":{"id":"…","source":"…","type":"…"},"parent":"…"}'