Create a webhook attached to a given deployment ID.
REQUIRED | KEY | TYPE | DESCRIPTION |
---|---|---|---|
Yes | deploymentId | str | Unique string identifier for the deployment this webhook will attach to. |
Yes | endpoint | str | URI that the webhook will send HTTP POST requests to. |
Yes | webhookEventType | str | One of 'DEPLOYMENT_START', 'DEPLOYMENT_SUCCESS', or 'DEPLOYMENT_FAILED'. |
No | payloadTemplate | dict | Template for the body of the HTTP POST requests. Defaults to {}. |
KEY | TYPE | DESCRIPTION | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
success | Boolean | true if the call succeeded, false if there was an error | |||||||||||||||||||||
result | Webhook |
|
TYPE | WHEN |
---|---|
DataNotFoundError |
|
InvalidEnumParameterError | An invalid value is passed for |
Coming Soon!