Webhooks

Configure incoming webhooks in your Workspace to automate a workflow when a Deployment alert gets triggered.

Create a webhook

Go to Workspace Integrations, and click Configure in the alert webhooks card. Click Add webhook and fill in the details of your webhook. Test the webhook functionality by clicking Test webhook.

Connect webhook to an alert rule

To call a specific webhook when an alert triggers, navigate to your Deployment Alerts and click Manage alert rules. Edit or add new alert rules, select the webhook(s) from the Webhooks dropdown, and click Save.

Payload

The payload send to the webhook URL is different for each use case, but always contains a title, text and type key.

Alert

{  
    "type": 1,
    "title": "Alert example",
    "text": "Response time has reached the threshold (100) with a value of (105) at 01/01/2024, 20:00:00 UTC",
    "workspaceId": "b6d8c781-2526-4e03-9b43-4c1a62d064db",
    "deploymentId": "b6d8c781-2526-4e03-9b43-4c1a62d064db",
    "alertruleId": "b6d8c781-2526-4e03-9b43-4c1a62d064db"
}

Test

{  
    "type": 0,
    "title": "Test example",
    "text": "Testing your Test example webhook on Deeploy"
}