Skip to content

Actions API

Base path: /api/sources/{slug}/actions

GET /api/sources/{slug}/actions

Returns all actions attached to the source.

POST /api/sources/{slug}/actions
Content-Type: application/json
{
"type": "webhook",
"target_url": "https://example.com/hook",
"is_active": true
}
FieldTypeRequiredDescription
typestringYesOne of: webhook, slack, smtp, twilio, javascript
target_urlstringFor webhookDestination URL
script_bodystringFor javascriptJavaScript source code
signing_secretstringNoHMAC-SHA256 signing secret
configobjectFor slack/smtp/twilioType-specific configuration (see Action Types)
transform_scriptstringNoPer-action transform script
is_activebooleanNoWhether the action is active (default: true)
GET /api/sources/{slug}/actions/{id}
PATCH /api/sources/{slug}/actions/{id}
Content-Type: application/json
{
"is_active": false
}
DELETE /api/sources/{slug}/actions/{id}