Add Webhooks
Learn how to use Webhooks in Humanitec.
Webhooks allow you to set up complex workflows by connecting your Internal Developer Platform with other systems (e.g., to send a Slack or Microsoft Teams message once a Deployment has successfully finished). In this section, you will learn how to create, edit, delete a Webhook for your App and how to modify the Webhook payload.
To create a webhook, you will need to have the
Administrator role within your Organization or hold the Owner role on the App. Learn more about RBAC in Humanitec here.UI
CLI
API
- Navigate to the Manage webhooks section.
- Insert your Webhook name and URL.
- Click Create. You will see a webhook added below.
Example for a Webhook
All webhooks by default are set to All triggers and have a default payload that contains only the common properties of all the selected events.
{
"event": "${event}",
"triggered_at": "${triggered_at}",
"triggered_by": "${triggered_by}",
"org_id": "${org_id}",
"app_id": "${app_id}",
"env_id": "${env_id}"
}
You can change the payload by selecting a different trigger from the triggers dropdown. The payload will change accordingly.
You can also customize the payload by using placeholders. Every payload parameter is available to a user as a placeholder with the format
${parameter_name}.Parameter | Description |
|---|---|
event | The ID of the event |
org_id | The organization the event occurred in |
triggered_at | The datetime of triggering the underlying event |
triggered_by | The user who triggered the underlying event |
Parameter | Description |
|---|---|
app_id | The application the environment created in |
env_id | The environment ID |
name | The environment name |
type | The environment type |
Parameter | Description |
|---|---|
app_id | The application the deployment occurred in |
env_id | The environment the deployment occurred in |
deploy_id | The deployment ID |
delta_id | The deployment delta id |
set_id | The deployment set id |
comment | The deployment comment |
status | The deployment status |
Example payload for a
deployment.finished event:{
"event": "${event}",
"org_id": "${org_id}",
"app_id": "${app_id}",
"env_id": "${env_id}",
"triggered_at": "${triggered_at}",
"triggered_by": "${triggered_by}",
"deploy_id": "${deploy_id}",
"delta_id": "${delta_id}",
"set_id": "${set_id}",
"comment": "${comment}",
"status": "${status}"
}
To edit or delete a webhook, you will need to have the
Administrator role within your Organization or hold the Owner role on the App. Learn more about RBAC in Humanitec here.UI
CLI
API
- Navigate to the Manage webhooks section.
- Clicking on the three dots on the right side of your webhook and selecting the according option.
Edit or delete the Webhook
You can update a webhook via the Update Webhook endpoint. Webhooks can be deleted via the Delete Webhook endpoint.
Last modified 7mo ago