Upcoming Release

Subscribe to event triggers from Canopy.

View as Markdown
PUT /organization/subscribe
O auth2

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.

application/json

Body Required

  • webhook_url string(uri) Required
  • failure_notification_protocol string

    The SNS protocol used to notify the client about a failed webhook

  • failure_notification_endpoint string

    The endpoint value that SNS will send the notification

Responses

  • 201

    Webhook created.

  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 422

    Invalid input

  • 429

    Too many requests.

  • default

    Unexpected Error.

PUT /organization/subscribe 
curl \
 --request PUT 'https://sandbox-api.canopyservicing.com/organization/subscribe' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"webhook_url":"https://myserver.com/send/webhook/canopy","failure_notification_protocol":"email","failure_notification_endpoint":"client@email.com"}'
Request examples 
{
  "webhook_url": "https://myserver.com/send/webhook/canopy",
  "failure_notification_protocol": "email",
  "failure_notification_endpoint": "client@email.com"
}