GET https://api.ap1.datadoghq.com/api/v2/integration/webhooks/configuration/auth-methodhttps://api.ap2.datadoghq.com/api/v2/integration/webhooks/configuration/auth-methodhttps://api.datadoghq.eu/api/v2/integration/webhooks/configuration/auth-methodhttps://api.ddog-gov.com/api/v2/integration/webhooks/configuration/auth-methodhttps://api.us2.ddog-gov.com/api/v2/integration/webhooks/configuration/auth-methodhttps://api.datadoghq.com/api/v2/integration/webhooks/configuration/auth-methodhttps://api.us3.datadoghq.com/api/v2/integration/webhooks/configuration/auth-methodhttps://api.us5.datadoghq.com/api/v2/integration/webhooks/configuration/auth-method
Overview
Get a list of all auth methods configured for the Webhooks integration in
your organization.
This endpoint requires the integrations_read permission.
Arguments
Query Strings
Comma-separated list of relationships to include in the response.
Allowed enum values: oauth2-client-credentials
Response
OK
Response containing a list of webhooks auth methods.
Expand All
An array of webhooks auth methods.
Attributes of a webhooks auth method.
Authentication protocol used by the auth method.
Allowed enum values: oauth2-client-credentials
The ID of the auth method.
Relationships of a webhooks auth method to its protocol-specific resource.
oauth2-client-credentials
Relationship pointing to the OAuth2 client credentials resource for this auth method.
Relationship data referencing an OAuth2 client credentials resource.
The ID of the OAuth2 client credentials resource.
OAuth2 client credentials resource type.
Allowed enum values: webhooks-auth-method-oauth2-client-credentials
default: webhooks-auth-method-oauth2-client-credentials
Webhooks auth method resource type.
Allowed enum values: webhooks-auth-method
default: webhooks-auth-method
Resources related to the auth methods, included when requested via the include query parameter.
OAuth2 client credentials attributes returned by the API. The client_secret is never echoed.
URL of the OAuth2 access token endpoint.
The intended audience for the OAuth2 access token.
The OAuth2 client ID issued by the authorization server.
Human-readable name for this auth method.
Authentication protocol used by the auth method.
Allowed enum values: oauth2-client-credentials
Space-separated list of OAuth2 scopes to request.
The ID of the OAuth2 client credentials auth method.
OAuth2 client credentials resource type.
Allowed enum values: webhooks-auth-method-oauth2-client-credentials
default: webhooks-auth-method-oauth2-client-credentials
{
"data": [
{
"attributes": {
"protocol": "oauth2-client-credentials"
},
"id": "596da4af-0563-4097-90ff-07230c3f9db3",
"relationships": {
"oauth2-client-credentials": {
"data": {
"id": "596da4af-0563-4097-90ff-07230c3f9db3",
"type": "webhooks-auth-method-oauth2-client-credentials"
}
}
},
"type": "webhooks-auth-method"
}
],
"included": [
{
"attributes": {
"access_token_url": "https://example.com/oauth/token",
"audience": "https://api.example.com",
"client_id": "my-client-id",
"name": "my-oauth2-auth",
"protocol": "oauth2-client-credentials",
"scope": "read:webhooks write:webhooks"
},
"id": "596da4af-0563-4097-90ff-07230c3f9db3",
"type": "webhooks-auth-method-oauth2-client-credentials"
}
]
}
Forbidden
{
"errors": [
"Bad Request"
]
}
Too many requests
{
"errors": [
"Bad Request"
]
}
Code Example
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/integration/webhooks/configuration/auth-method" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
