AlmondTill/G3N API

On this page

doomWebhookSubscription

mutation · in the family Webhook subscription

What it does

Permanently retire a webhook subscription — your endpoint, signed and POSTed when the events you picked happen.

active/inactive/suspended → doomed (terminal — gate-protected; the credential-store signing secret dies with it; authority:manage_integration).

Careful

Doom is forever — a doomed record never comes back into use (its history remains readable). Anything still referencing it live will block the doom.

Who may call it

Capability area: System and integration setup — Registers, connections and the settings your systems run on.

Arguments

NameTypeRequiredNotes
idID ID!yesThe id of the record.
revisionID ID!yesThe revision id you read on the record; the change is refused if an edit landed in the meantime.
reasonStringnoNo further notes.

Returns

WebhookSubscription WebhookSubscription! — A WebhookSubscription — the documented non-GraphQL edge OUT (mirrors the inbound Stripe webhook edge): the merchant registers an https target URL + a filtered set event names (the DERIVED deliverable universe — transition success events + per-construct birth names; enumerate it via the integrator docs), and the delivery lane POSTs HMAC-signed THIN payloads at-least-once with retries/backoff/DLQ. The payload names {id, event, occurredAt, construct{type,id}, revision, subscriptionId} — the receiver dedupes on id and READS the record through this SAME API with its ApiKey (no fat payloads, no parallel surface). Signing mirrors the Stripe scheme (almondtill-signature: t=<unix>,v1=<hex HMAC-SHA256 of <t>.<body> under the secret>); the secret shows ONCE at create/rotate and lives in the non-streamed credential store, never on the record. GROUP-parented (parentId === rootId); born active; 20 consecutive delivery failures fire the automatic active → suspended flip (system:repeated_delivery_failure — the deliverer, never a caller); reactivate serves both inactive → active and suspended → active (fix the endpoint, then reactivate; missed events do NOT replay — re-sync via the API). Owner-gated end to end (the mintApiKey posture); NOT searchable (integration config — reached via the owner-gated list).

Example request

mutation ExampleDoomWebhookSubscription($id: ID!, $revision: ID!, $reason: String) {
  doomWebhookSubscription(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    targetUrl
    eventTypes
    consecutiveFailures
    lastFailureAt
    lastFailureCode
    suspendedAt
    secretRotatedAt
    pluginId
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000",
  "revision": "01900000-0000-7000-8000-b7960e180000",
  "reason": "Correcting a miscount."
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "doomWebhookSubscription": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "WH-EXMP-0000-000F",
      "type": "WebhookSubscription",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000",
      "targetUrl": "https://example.com/hook",
      "eventTypes": [
        "<event types>"
      ],
      "consecutiveFailures": 1,
      "lastFailureAt": "2027-01-31T00:00:00.000Z",
      "lastFailureCode": "BJ-001",
      "suspendedAt": "2027-01-31T00:00:00.000Z",
      "secretRotatedAt": "2027-01-31T00:00:00.000Z",
      "pluginId": "01900000-0000-7000-8000-bf0997d70000"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer