Get Webhook

What it does

Returns the webhook configuration that is currently active for the application — the destination URL, the custom headers the Gateway attaches when it calls you, and which event types you are subscribed to. Read-only; nothing is changed. Use it to verify a configuration after an update, or to check which events an app is receiving before you debug a missing payload.

GET and the update call share the same path. Sending the path with no body reads the configuration; sending a body updates it — see Update Webhook.

Endpoint

GET /api/v1/apps/{app_id}/webhook

Headers

string

required

Secret key in Bearer sk_... format. See Secret Key authentication.

Path parameters

string

required

Application ID. Must belong to the organization (otherwise 404).

Response

boolean

true when the configuration was read successfully.

object

The active webhook configuration.

Show data

string

UUID of the webhook configuration.

string

The HTTPS endpoint the Gateway posts events to.

object

Custom headers sent with every delivery, as a key → value map. Empty object when none are configured.

object

Event name → boolean map. See Webhook Event for the five values.

boolean

Whether deliveries are currently enabled for this configuration.

string

ISO-8601 timestamp of creation.

string

ISO-8601 timestamp of the last change.

Examples

Demo 1 — read the active webhook

GET /api/v1/apps/app_7poyXj8GXuv76e/webhook
Authorization: Bearer sk_...

{
  "data": {
    "id": "bb17a17e-9ce1-4c78-88ac-b48f53d322bc",
    "url": "https://webhook.site/89ac1ca8-22cc-42c3-9f07-49a47f8f6a13",
    "headers": {
      "X-Signature-Token": "s3cr3t"
    },
    "subscribedEvents": {
      "messages": true,
      "message_status": true,
      "message_template_status": false,
      "read": true,
      "account": false
    },
    "isActive": true,
    "createdAt": "2026-08-10T22:45:42.314912Z",
    "updatedAt": "2026-08-20T13:36:56.564277Z"
  },
  "isSuccess": true
}

Demo 2 — app not in the organization → 404

GET /api/v1/apps/app_notMine/webhook
Authorization: Bearer sk_...

{ "errors": { "code": "APPLICATION_004", "group": "NOT_FOUND", "description": "Application not found." }, "isSuccess": false }

Errors

object

Error details with code, group, and description; isSuccess is false.

HTTP	Code	Group	When
401	`ORGANIZATION_SECRET_010`	`NOT_FOUND`	Authorization / secret key is missing.
401	`ORGANIZATION_SECRET_011`	`NOT_FOUND`	Secret key is invalid.
404	`APPLICATION_004`	`NOT_FOUND`	`app_id` does not belong to the organization.

Getting Started

Analytics

Application

Template

Media

Developers

Reference

What it does

Endpoint

Headers

Path parameters

Response

Examples

Errors

Next steps

Update Webhook

Webhook payloads

​What it does

​Endpoint

​Headers

​Path parameters

​Response

​Examples

​Errors

​Next steps

Update Webhook

Webhook payloads

What it does

Endpoint

Headers

Path parameters

Response

Examples

Errors

Next steps