Webhook 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
Application configuration events
Application configurations are configurations you’ve deployed for your application. You can configure webhooks for the following application configuration events:
- Creation (application_configuration_create event)—Notification is sent when an application configuration is created
- Override (application_configuration_override event)—Notification is sent when an application configuration is overwritten
- Deployment (application_configuration_deploy event)—Notification is sent when an application configuration is deployed
- Undeployment (application_configuration_undeploy event)—Notification is sent when an application configuration is deleted from an environment
Deployment events
Deployment events are linked to a deployment request or approval outcome. You can configure webhooks for the following events:
- Request (application_configuration_deployment_request event)—Notification is sent when a deployment is requested for an application configuration
- Publish (application_configuration_deployment_request_outcome event)—Notification is sent when a deployment request is approved (published) or rejected
application_configuration_create
The application_configuration_create event payload provides information about the application configuration tag that was created. In particular, it includes the following top-level fields:
| Field | Description |
|---|---|
| event | Name of the event that triggered the webhook. |
| config | Details about the application configuration that was created. |
For more information about the application configuration fields provided in the payload, see Application configurations in the Mix.api documentation.
application_configuration_override
The application_configuration_override event payload provides information about the application configuration tag that overrode an existing application configuration. In particular, it includes the following top-level fields:
| Field | Description |
|---|---|
| event | Name of the event that triggered the webhook. |
| config | Details about the new application configuration, including the ID of the application configuration that was overridden (in parentId). |
For more information about the application configuration fields provided in the payload, see Application configurations in the Mix.api documentation.
application_configuration_deploy
The application_configuration_deploy event payload provides information about the application configuration tag that was deployed. In particular, it includes the following top-level fields:
| Field | Description |
|---|---|
| event | Name of the event that triggered the webhook. |
| config | Details about the deployed application configuration, including the environment and geographies where the application configuration was deployed. |
For more information about the application configuration fields provided in the payload, see Application configurations in the Mix.api documentation.
application_configuration_undeploy
The application_configuration_undeploy event payload provides information about the application configuration tag that was deleted from an environment. In particular, it includes the following top-level fields:
| Field | Description |
|---|---|
| event | Name of the event that triggered the webhook. |
| config | Details about the undeployed application configuration, including the environment and geographies where the application configuration was deleted. |
For more information about the application configuration fields provided in the payload, see Application configurations in the Mix.api documentation.
application_configuration_deployment_request
The application_configuration_deployment_request event payload provides information about an application configuration deployment request. In particular, it includes the following top-level fields:
| Field | Description |
|---|---|
| event | Name of the event that triggered the webhook. |
| deployment_request_timestamp | Date and time that the deployment was requested |
| config | Details about the deployment request, including the environment and geographies where to deploy the application configuration. |
For more information about the application configuration fields provided in the payload, see Application configurations in the Mix.api documentation.
application_configuration_deployment_request_outcome
The application_configuration_deployment_request_outcome event payload provides the outcome of an application configuration deployment request. In particular, it includes the following top-level fields:
| Field | Description |
|---|---|
| event | Name of the event that triggered the webhook. |
| outcome | Outcome of the deployment request. Valid values are approved and rejected |
| deployment_outcome_timestamp | Date and time that the deployment was requested |
| config | Details about the deployment request, including the environment and geographies where to deploy the application configuration. |
For more information about the application configuration fields provided in the payload, see Application configurations in the Mix.api documentation.
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.