APIWebhooks
Get the webhook condition schema
The fields a condition expression can reference.
GET
The fields a condition expression can reference.
ApiKeyAuthheader
AuthorizationBearer <token>Bearer token authentication. Send an API key (a saai_api_-prefixed token) as Authorization: Bearer <token>.
Required permission
view_webhooksThe request has succeeded.
application/json- response
The condition surface: envelope fields every event carries, plus the payload fields each action adds.
envelope*Fields under the event variable.
payloads*Payload fields, keyed by action.
curl -X GET "https://example.com/webhooks/schema"{ "envelope": { "property1": { "type": "string", "description": "string", "fields": { "property1": {}, "property2": {} } }, "property2": { "type": "string", "description": "string", "fields": { "property1": {}, "property2": {} } } }, "payloads": { "property1": { "property1": { "type": "string", "description": "string", "fields": { "property1": {}, "property2": {} } }, "property2": { "type": "string", "description": "string", "fields": { "property1": {}, "property2": {} } } }, "property2": { "property1": { "type": "string", "description": "string", "fields": { "property1": {}, "property2": {} } }, "property2": { "type": "string", "description": "string", "fields": { "property1": {}, "property2": {} } } } }}