...
| Code Block | ||
|---|---|---|
| ||
{
"name": "<webhook_configuration_name>",
"description": "<webhook_configuration_description>",
"hooks": [
{
"type": "<webhook_type>",
"method": "POST",
"endpoint": "<external_endpoint_url>",
"origin": {
"method": "POST",
"endpoint": "https://gql.doo.net",
"body": "<graphql_query>"
}
}
],
"authentication": {
"grant_type": "client_credentials",
"endpoint": "<external_oauth_endpoint_url>",
"credentials": {
"client_id": "doo",
"client_secret": "<external_client_secret>"
},
"header_format": "Authorization",
"header_value_format": "Bearer %ACCESS_TOKEN%"
}
} |
If the <external_endpoint_url> is not protected with OAuth, you can omit the authentication object in the configuration object. In this case, doo will send the webhook request without access_token. See Webhook request for more information.
Parameters
Parameter | Required | Description |
|---|---|---|
| Yes | Webhook configuration name |
| No | Webhook configuration description |
| Yes | Webhook type name from Supported resources and webhook types without |
| Yes | External API endpoint where doo sends the webhook payload for the specified webhook type. See Webhook request |
| Yes | GraphQL query which specifies the webhook payload structure. |
| Yes, if | External authorization OAuth API endpoint where doo can retrieve See Webhook request |
| Yes, if | A valid OAuth Client Secret pre-shared with doo. |
...