About webhooks
Webhooks are POST requests sent to a web application when a specific event is triggered. For example, you can configure a webhook that will send a notification when a new application configuration tag is created or an application configuration is deployed.
Mix webhooks provide a payload that includes data related to the triggered event. You can then use this data to call Mix.api endpoints.
Example use cases
Consider these use cases:
-
Your deployment flow requires an approval when deploying to an environment. You can create a webhook that will send a notification to your web application when a deployment request is triggered in the environment that requires approval. Using the data provided in the webhook, you can send an email to a list of approvers indicating that an approval is pending.
-
You are hosting your own deployment environments on premises. You can create a webhook that will send a notification when a deployment request is triggered. Using the data provided in the webhook, you can call Mix.api to download the resources for the application configuration and then deploy them in your environments.
Permissions
To create, update, or delete a webhook, a user must have the following application and organization roles:
- Owner or viewer of the application for which webhooks are created, and
- Owner or member of the organization where the application resides
To view webhooks, a user must have the following application and organization roles:
- Owner or viewer of the application for which webhooks are created, and
- Owner, member, or viewer of the organization where the application resides
Available events
There are two types of events that can trigger a webhook:
- Application configuration events: Triggers linked to key application configuration actions
- Deployment events: Triggers linked to a deployment request or approval outcome
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.