Webhooks

Get a webhook subscription

Returns a single webhook subscription by UUID. The full signing secret is NOT returned — only its prefix (first 10 chars) is exposed for identification.

GET /webhooks/{webhookId}

Get a webhook subscription

curl --request GET \
  --url 'https://api.sotion.so/api/v1/webhooks/{WEBHOOKID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "data": {
    "id": "<uuid>",
    "name": "<string>",
    "url": "<url>",
    "events": [
      "member.created"
    ],
    "active": true,
    "secretPrefix": "<string>",
    "managedBy": "<string>",
    "createdAt": "<date-time>",
    "updatedAt": "<date-time>"
  }
}

Webhook details.

Authorizations

  • Authorization string required header

    Per-site API key (prefix: so_...). Each key is scoped to exactly one Sotion site — the site context is determined entirely by the key. No site ID is needed in any URL. Pass as: Authorization: Bearer so_...

Path Parameters

  • webhookId string (uuid) required

    UUID of the webhook subscription. Get webhook IDs from listWebhooks or createWebhook responses.

Response

application/json
  • X-RateLimit-Limit integer response header

    Maximum requests allowed in the current window.

  • X-RateLimit-Remaining integer response header

    Requests remaining in the current window.

  • X-RateLimit-Reset integer response header

    Unix timestamp (seconds) when the rate limit window resets.

  • X-Request-Id string (uuid) response header

    Unique request identifier for support and debugging.

  • data object
    + Show Child Attributes
    • id string (uuid)

      Unique identifier for the webhook subscription.

    • name string

      Display name for the subscription. Auto-generated when not provided on create.

    • url string (uri)

      HTTPS delivery URL. Sotion POSTs signed event envelopes here.

    • events[] string enum arrayenum

      Event types this subscription receives. Event type that can be subscribed to. See the Webhook Events reference for payload shapes. 9 allowed enum values.

    • active boolean

      Whether the subscription is currently delivering events.

    • secretPrefix string

      First 10 characters of the signing secret, used to identify which secret an integration holds. The full secret is only returned on create.

    • managedBy string nullable

      External system that owns this subscription (e.g. 'zapier'). Null when user-managed via the dashboard.

    • createdAt string (date-time) nullable

      When the subscription was created.

    • updatedAt string (date-time) nullable

      When the subscription was last modified.