Skip to main content
POST
/
hooks
/
{toolId}
Handle incoming webhook
curl --request POST \
  --url https://api.superglue.ai/v1/hooks/{toolId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "evt_1234",
  "type": "customer.created",
  "data": {
    "object": {
      "id": "cus_abc123",
      "email": "user@example.com"
    }
  }
}
'
{
  "runId": "7f3e9c1a-2b4d-4e8f-9a3b-1c5d7e9f2a4b",
  "status": "accepted",
  "toolId": "handle-stripe-webhook"
}

Authorizations

​
Authorization
string
header
required

Static API key authentication using Bearer token scheme. Include your API key in the Authorization header: Authorization: Bearer YOUR_API_KEY

Alternatively, you can use the token query parameter to authenticate.

API keys can be generated in your superglue dashboard.

Path Parameters

​
toolId
string
required

ID of the tool to trigger

Query Parameters

​
mode
enum<string>
default:prod

Execution mode for system resolution. Use "dev" to execute with sandbox/dev system credentials.

Available options:
prod,
dev

Body

application/json

Webhook payload from the external service. Becomes the tool's input.

The body is of type object.

Response

Webhook accepted, tool execution started

​
runId
string
required

ID of the created run

Example:

"7f3e9c1a-2b4d-4e8f-9a3b-1c5d7e9f2a4b"

​
status
enum<string>
required
Available options:
accepted
Example:

"accepted"

​
toolId
string
required

ID of the triggered tool

Example:

"handle-stripe-webhook"