OAuth webhooks
If you want to setup a webhook but can only support webhooks that are behind a OAuth authorization you can use the OAuth webhook push notification type. To set this up initially follow this guide.
We currently only support the client_credentials grant type of OAuth 2.0. If you can't support that version or grant type, we currently can't talk with your OAuth authorized webhook.
To configure this you will need to share the following options with us:
| Option | Description |
|---|---|
| Endpoint | The URL where we will send the notifications to. |
| OauthEndpoint | The URL we need to send our requests for an access_token to |
| ClientId | The client id we will need to send to your OAuth endpoint to identify us |
| ClientSecret | The associated secret for that client id so that your OAuth service can authorize us |
| Scope | Optional The scope we will request from you OAuth endpoint. |
For more information about the values, please read the Client Credentials documentation on oauth.com or the documentation of the OAuth solution you are using on your server.
Make sure that the when you register a device you will set the push type to OAuth webhook so that we will use this configuration.
For a documentation of the contents of the notifications we send please read that section on the page about Webhooks.