Skip to content
Console
On this page

Support actions

SupportAction is the case's business intent ledger, NOT an email outbox or notify_deliveries row.

This method is not served on the public API. api.sylphx.com does 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.

SupportAction is the case's business intent ledger, NOT an email outbox or notify_deliveries row. Transport changes never mutate this record implicitly. Stable keys and payload hashes survive all attempts, uncertain outcomes and migration. Exactly-once visible results require duplicate-safe transport AND authoritative provider/tenant reconciliation, not exactly-once HTTP delivery.

Service Sylphx Notify · Resource type notify.sylphx.com/SupportAction · Name pattern orgs/{org}/projects/{project}/envs/{env}/support_cases/{support_case}/support_actions/{support_action} · Shape record

Fields

FieldTypeWhat it is
namestringCanonical action name.
uidstringImmutable identity. Output only.
metaResourceMetaStrong ETag and creation/update times.
idempotency_keystringExact stable caller/source key; never replaced on retry or cutover.
payload_sha256stringSHA-256 of immutable admitted intent bytes; changed-key reuse is refused.
track_idstringRelated action/issue track in the same case.
stateSupportActionStateBusiness state, independently versioned from the transport. Output only. One of pending, in_flight, uncertain, succeeded, failed, cancelled.
versionint64Optimistic concurrency version of the business action. Output only.
actorSupportActorAuthenticated creator or admitting workload. Output only.
replySupportChannelReplyReply using an existing channel authority. One of the intent group.
remedySupportRemedyRequestRequest the tenant's own remedy API; Support never writes product data. One of the intent group.
escalationSupportEscalationNotify an accountable reviewer through an existing API. One of the intent group.
receiptSupportActionReceiptLatest authoritative receipt; dispatch/admission alone is not completion. Output only.
failure_causestringCause and unknown effect are separate facts. Output only.
reconcile_timetimestampNext permitted reconciliation/query time; UNKNOWN never means resend. Output only.
source_recordsSupportSourceRecord[]Source outbox ID/key/payload/leases/attempts retained as protected evidence.
attempt_countint32Current dispatch attempt number; advances only on a new fenced claim. Output only.
uncertainty_episodeint64Storage-owned monotonic generation, incremented on each entry to UNCERTAIN. A reconciliation receipt must resolve this exact episode and attempt. 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.

MethodCallWhat it does
GETgetGets one SupportAction; protected identities require a separately audited reveal.
GETlistLists scoped support_actions; no cross-tenant or internal-message projection.
POSTcreateCreates an idempotent SupportAction; changed replay and illegal state are refused.
POSTbegin_support_action_attemptClaims one fenced attempt of a conclusively dispatchable action. An expired in-flight claim becomes UNCERTAIN, never PENDING.
POSTrecord_support_action_receiptRecords an authenticated immutable authority receipt. Transport state changes alone never change a case or business action.
POSTreconcileQueries the original authority/key first; UNKNOWN remains UNCERTAIN. Only a verified NOT_APPLIED query receipt for the current attempt and uncertainty episode permits another attempt of the same action/key.

get

Gets one SupportAction; protected identities require a separately audited reveal.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/support_cases/support-case/support_actions/support-action · scope notify:support:read · effect read · not available yet · Request, response and examples

list

Lists scoped support_actions; no cross-tenant or internal-message projection.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/support_cases/support-case/support_actions · scope notify:support:read · effect read · not available yet · paginated · Request, response and examples

create

Creates an idempotent SupportAction; changed replay and illegal state are refused.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/support_cases/support-case/support_actions · scope notify:support:actions · effect write · not available yet · validate_only · Request, response and examples

begin_support_action_attempt

Claims one fenced attempt of a conclusively dispatchable action. An expired in-flight claim becomes UNCERTAIN, never PENDING.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/support_cases/support-case/support_actions/support-action:beginSupportActionAttempt · scope notify:support:dispatch · effect write · not available yet · validate_only · Request, response and examples

record_support_action_receipt

Records an authenticated immutable authority receipt. Transport state changes alone never change a case or business action.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/support_cases/support-case/support_actions/support-action:recordSupportActionReceipt · scope notify:support:receipts · effect write · not available yet · validate_only · Request, response and examples

reconcile

Queries the original authority/key first; UNKNOWN remains UNCERTAIN. Only a verified NOT_APPLIED query receipt for the current attempt and uncertainty episode permits another attempt of the same action/key.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/support_cases/support-case/support_actions/support-action:reconcile · scope notify:support:reconcile · effect write · not available yet · validate_only · Request, response and examples