Subscribe to event triggers from Canopy.
PUT
/organization/subscribe
As events occur in Canopy, your external system can be notified of them and handle them. For a breakdown of how Canopy will post to your webhook URL upon completion of events, review our Webhook Events definition.
Body Required
-
webhook_url string(uri) Required
-
The SNS protocol used to notify the client about a failed webhook
-
The endpoint value that SNS will send the notification
PUT /organization/subscribe
curl \
-X PUT https://<your_environment_name>-uat-api.canopyservicing.com/organization/subscribe \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"webhook_url":"https://myserver.com/send/webhook/canopy","failure_notification_protocol":"email","failure_notification_endpoint":"client@email.com"}'
Request example
{
"webhook_url": "https://myserver.com/send/webhook/canopy",
"failure_notification_protocol": "email",
"failure_notification_endpoint": "client@email.com"
}