Integrations


Integrations (webhook and Slack notifications) can be managed pragmatically using the Node.js API.

Create Integration

Required API Permission: Create Integrations
ParameterRequiredDescription
siteYesSite slug, found in site settings
urlYesThe URL of where the webhook will be delivered via HTTP POST as application/json
eventsYesAn array of events. Eg: ['new_snapshot']
destinationYesThe destination of this integration. Either 'slack' or 'webhook'

List Integrations

Required API Permission: Read Sites
ParameterRequiredDescription
siteYesSite slug, found in site settings

Update Integration

Required API Permission: Update Integrations
ParameterRequiredDescription
siteYesSite slug, found in site settings
uuidYesThe UUID of a given integration
urlYesThe URL of where the webhook will be delivered via HTTP POST as application/json
eventsYesAn array of events. Eg: ['new_snapshot']
destinationYesThe destination of this integration. Either 'slack' or 'webhook'
isDisabledNoA boolean. Is this integration enabled?

Delete Integration

Required API Permission: Delete Integrations
ParameterRequiredDescription
siteYesSite slug, found in site settings
uuidYesThe UUID of a given integration

Related Articles