Webhook Authorization
Complete the following steps to authorize with your target webhooks resource. If no authorization is required, you may select the Webhook endpoint does not require authorization option below.
If you are new to creating authorizations in Lytics, see the Authorizations Dashboard documentation for more information.
- Select Webhook from the list of providers.
- Select the method for authorization. Webhooks support the following authorization methods:
- Enter a Label to identify your authorization.
- (Optional) Enter a Description for further context on your authorization.
- Complete the configuration steps needed for your authorization. These steps will vary by method.
- Click Save Authorization.
Provide authorization as request header or parameter
To provide authorization as a request header or parameter you will need to enter the following:
- In the Label text box, enter a name for the authorization
- (optional) In the Description text box, enter a description for this authorization
- (optional) In the Webhook Request Headers text box, enter Enter headers for the webhook POST request. Add a new line for each header as key:value e.g.
Authorization: some-token
. - (optional) In the Webhook Request Parameters text box, enter Enter URL parameters for the webhook POST request. e.g.
param-key1=value1¶m-key2=value2
.
OAuth 2.0 Client Credentials Grant
For authorizing with an OAuth 2.0 Client Credentials Grant you will need the following credentials. Once these are submitted, they will be used to retrieve an access token from the Token URL and stored securely in order to retrieve a new token when the existing one expires. When a job is configured using this authorization, the access token will be included in calls from the export as a header in the form Authorization: Bearer <access token>
:
- In the Label text box, enter a name for the authorization
- (optional) In the Description text box, enter a description for this authorization
- In the Token URL text box, enter the Oauth2 token URL for the service you wish to connect to. ex: https://www.example.com:9031/as/token.oauth2.
- In the Client ID text box, enter the Client ID for the client you wish to use to connect to the service.
- In the Client Secret password box, enter the Client Secret for the client you wish to use to connect to the service.
- (optional) In the Scopes text box, enter the authorization scopes to request from the service.