Configure your Datadog-Webhooks integration directly through the Datadog API. For more information about the Datadog-Webhooks integration, see the integration page.
POST https://api.datadoghq.eu/api/v1/integration/webhooks/configuration/custom-variableshttps://api.ddog-gov.com/api/v1/integration/webhooks/configuration/custom-variableshttps://api.datadoghq.com/api/v1/integration/webhooks/configuration/custom-variableshttps://api.us3.datadoghq.com/api/v1/integration/webhooks/configuration/custom-variables
Creates an endpoint with the name <CUSTOM_VARIABLE_NAME>
.
Define a custom variable request body.
{
"is_secret": true,
"name": "CUSTOM_VARIABLE_NAME",
"value": "CUSTOM_VARIABLE_VALUE"
}
OK
Custom variable for Webhook integration.
{
"is_secret": true,
"name": "CUSTOM_VARIABLE_NAME",
"value": "CUSTOM_VARIABLE_VALUE"
}
Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}
Authentication error
Error response object.
{
"errors": [
"Bad Request"
]
}
# Curl command
curl -X POST "https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com/api/v1/integration/webhooks/configuration/custom-variables" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_CLIENT_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_CLIENT_APP_KEY}" \
-d @- << EOF
{
"is_secret": true,
"name": "CUSTOM_VARIABLE_NAME",
"value": "CUSTOM_VARIABLE_VALUE"
}
EOF
POST https://api.datadoghq.eu/api/v1/integration/webhooks/configuration/webhookshttps://api.ddog-gov.com/api/v1/integration/webhooks/configuration/webhookshttps://api.datadoghq.com/api/v1/integration/webhooks/configuration/webhookshttps://api.us3.datadoghq.com/api/v1/integration/webhooks/configuration/webhooks
Creates an endpoint with the name <WEBHOOK_NAME>
.
Create a webhooks integration request body.
Field
Type
Description
custom_headers
object
If null
, uses no header.
If given a JSON payload, these will be headers attached to your webhook.
<any-key>
string
Additional properties for custom headers.
encode_as
enum
Encoding type. Can be given either json
or form
.
Allowed enum values: json,form
name [required]
string
The name of the webhook. It corresponds with <WEBHOOK_NAME>
.
Learn more on how to use it in
monitor notifications.
payload
object
If null
, uses the default payload.
If given a JSON payload, the webhook returns the payload
specified by the given payload.
Webhooks variable usage.
url [required]
string
URL of the webhook.
{
"custom_headers": {
"<any-key>": "string"
},
"encode_as": "string",
"name": "WEBHOOK_NAME",
"payload": {},
"url": "https://example.com/webhook"
}
OK
Datadog-Webhooks integration.
Field
Type
Description
custom_headers
object
If null
, uses no header.
If given a JSON payload, these will be headers attached to your webhook.
<any-key>
string
Additional properties for custom headers.
encode_as
enum
Encoding type. Can be given either json
or form
.
Allowed enum values: json,form
name [required]
string
The name of the webhook. It corresponds with <WEBHOOK_NAME>
.
Learn more on how to use it in
monitor notifications.
payload
object
If null
, uses the default payload.
If given a JSON payload, the webhook returns the payload
specified by the given payload.
Webhooks variable usage.
url [required]
string
URL of the webhook.
{
"custom_headers": {
"<any-key>": "string"
},
"encode_as": "string",
"name": "WEBHOOK_NAME",
"payload": {},
"url": "https://example.com/webhook"
}
Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}
Authentication error
Error response object.
{
"errors": [
"Bad Request"
]
}
# Curl command
curl -X POST "https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com/api/v1/integration/webhooks/configuration/webhooks" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_CLIENT_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_CLIENT_APP_KEY}" \
-d @- << EOF
{
"name": "WEBHOOK_NAME",
"url": "https://example.com/webhook"
}
EOF
DELETE https://api.datadoghq.eu/api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}https://api.ddog-gov.com/api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}https://api.datadoghq.com/api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}https://api.us3.datadoghq.com/api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}
Deletes the endpoint with the name <CUSTOM_VARIABLE_NAME>
.
Name
Type
Description
custom_variable_name [required]
string
The name of the custom variable.
OK
Authentication error
Error response object.
{
"errors": [
"Bad Request"
]
}
Item Not Found
Error response object.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export custom_variable_name="CHANGE_ME"
# Curl command
curl -X DELETE "https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com/api/v1/integration/webhooks/configuration/custom-variables/${custom_variable_name}" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_CLIENT_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_CLIENT_APP_KEY}"
DELETE https://api.datadoghq.eu/api/v1/integration/webhooks/configuration/webhooks/{webhook_name}https://api.ddog-gov.com/api/v1/integration/webhooks/configuration/webhooks/{webhook_name}https://api.datadoghq.com/api/v1/integration/webhooks/configuration/webhooks/{webhook_name}https://api.us3.datadoghq.com/api/v1/integration/webhooks/configuration/webhooks/{webhook_name}
Deletes the endpoint with the name <WEBHOOK NAME>
.
Name
Type
Description
webhook_name [required]
string
The name of the webhook.
OK
Authentication error
Error response object.
{
"errors": [
"Bad Request"
]
}
Item Not Found
Error response object.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export webhook_name="CHANGE_ME"
# Curl command
curl -X DELETE "https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com/api/v1/integration/webhooks/configuration/webhooks/${webhook_name}" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_CLIENT_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_CLIENT_APP_KEY}"
GET https://api.datadoghq.eu/api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}https://api.ddog-gov.com/api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}https://api.datadoghq.com/api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}https://api.us3.datadoghq.com/api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}
Shows the content of the custom variable with the name <CUSTOM_VARIABLE_NAME>
.
If the custom variable is secret, returns null
for the <CUSTOM_VARIABLE_VALUE>
in the response payload.
Name
Type
Description
custom_variable_name [required]
string
The name of the custom variable.
OK
Custom variable for Webhook integration.
{
"is_secret": true,
"name": "CUSTOM_VARIABLE_NAME",
"value": "CUSTOM_VARIABLE_VALUE"
}
Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}
Authentication error
Error response object.
{
"errors": [
"Bad Request"
]
}
Item Not Found
Error response object.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export custom_variable_name="CHANGE_ME"
# Curl command
curl -X GET "https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com/api/v1/integration/webhooks/configuration/custom-variables/${custom_variable_name}" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_CLIENT_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_CLIENT_APP_KEY}"
GET https://api.datadoghq.eu/api/v1/integration/webhooks/configuration/webhooks/{webhook_name}https://api.ddog-gov.com/api/v1/integration/webhooks/configuration/webhooks/{webhook_name}https://api.datadoghq.com/api/v1/integration/webhooks/configuration/webhooks/{webhook_name}https://api.us3.datadoghq.com/api/v1/integration/webhooks/configuration/webhooks/{webhook_name}
Gets the content of the webhook with the name <WEBHOOK_NAME>
.
Name
Type
Description
webhook_name [required]
string
The name of the webhook.
OK
Datadog-Webhooks integration.
Field
Type
Description
custom_headers
object
If null
, uses no header.
If given a JSON payload, these will be headers attached to your webhook.
<any-key>
string
Additional properties for custom headers.
encode_as
enum
Encoding type. Can be given either json
or form
.
Allowed enum values: json,form
name [required]
string
The name of the webhook. It corresponds with <WEBHOOK_NAME>
.
Learn more on how to use it in
monitor notifications.
payload
object
If null
, uses the default payload.
If given a JSON payload, the webhook returns the payload
specified by the given payload.
Webhooks variable usage.
url [required]
string
URL of the webhook.
{
"custom_headers": {
"<any-key>": "string"
},
"encode_as": "string",
"name": "WEBHOOK_NAME",
"payload": {},
"url": "https://example.com/webhook"
}
Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}
Authentication error
Error response object.
{
"errors": [
"Bad Request"
]
}
Item Not Found
Error response object.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export webhook_name="CHANGE_ME"
# Curl command
curl -X GET "https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com/api/v1/integration/webhooks/configuration/webhooks/${webhook_name}" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_CLIENT_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_CLIENT_APP_KEY}"
PUT https://api.datadoghq.eu/api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}https://api.ddog-gov.com/api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}https://api.datadoghq.com/api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}https://api.us3.datadoghq.com/api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}
Updates the endpoint with the name <CUSTOM_VARIABLE_NAME>
.
Name
Type
Description
custom_variable_name [required]
string
The name of the custom variable.
Update an existing custom variable request body.
{
"is_secret": false,
"name": "CUSTOM_VARIABLE_NAME",
"value": "CUSTOM_VARIABLE_VALUE"
}
OK
Custom variable for Webhook integration.
{
"is_secret": true,
"name": "CUSTOM_VARIABLE_NAME",
"value": "CUSTOM_VARIABLE_VALUE"
}
Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}
Authentication error
Error response object.
{
"errors": [
"Bad Request"
]
}
Item Not Found
Error response object.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export custom_variable_name="CHANGE_ME"
# Curl command
curl -X PUT "https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com/api/v1/integration/webhooks/configuration/custom-variables/${custom_variable_name}" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_CLIENT_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_CLIENT_APP_KEY}" \
-d @- << EOF
{}
EOF
PUT https://api.datadoghq.eu/api/v1/integration/webhooks/configuration/webhooks/{webhook_name}https://api.ddog-gov.com/api/v1/integration/webhooks/configuration/webhooks/{webhook_name}https://api.datadoghq.com/api/v1/integration/webhooks/configuration/webhooks/{webhook_name}https://api.us3.datadoghq.com/api/v1/integration/webhooks/configuration/webhooks/{webhook_name}
Updates the endpoint with the name <WEBHOOK_NAME>
.
Name
Type
Description
webhook_name [required]
string
The name of the webhook.
Update an existing Datadog-Webhooks integration.
Field
Type
Description
custom_headers
object
If null
, uses no header.
If given a JSON payload, these will be headers attached to your webhook.
<any-key>
string
Additional properties for custom headers.
encode_as
enum
Encoding type. Can be given either json
or form
.
Allowed enum values: json,form
name
string
The name of the webhook. It corresponds with <WEBHOOK_NAME>
.
Learn more on how to use it in
monitor notifications.
payload
object
If null
, uses the default payload.
If given a JSON payload, the webhook returns the payload
specified by the given payload.
Webhooks variable usage.
url
string
URL of the webhook.
{
"custom_headers": {
"<any-key>": "string"
},
"encode_as": "string",
"name": "WEBHOOK_NAME",
"payload": {},
"url": "https://example.com/webhook"
}
OK
Datadog-Webhooks integration.
Field
Type
Description
custom_headers
object
If null
, uses no header.
If given a JSON payload, these will be headers attached to your webhook.
<any-key>
string
Additional properties for custom headers.
encode_as
enum
Encoding type. Can be given either json
or form
.
Allowed enum values: json,form
name [required]
string
The name of the webhook. It corresponds with <WEBHOOK_NAME>
.
Learn more on how to use it in
monitor notifications.
payload
object
If null
, uses the default payload.
If given a JSON payload, the webhook returns the payload
specified by the given payload.
Webhooks variable usage.
url [required]
string
URL of the webhook.
{
"custom_headers": {
"<any-key>": "string"
},
"encode_as": "string",
"name": "WEBHOOK_NAME",
"payload": {},
"url": "https://example.com/webhook"
}
Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}
Authentication error
Error response object.
{
"errors": [
"Bad Request"
]
}
Item Not Found
Error response object.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export webhook_name="CHANGE_ME"
# Curl command
curl -X PUT "https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com/api/v1/integration/webhooks/configuration/webhooks/${webhook_name}" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_CLIENT_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_CLIENT_APP_KEY}" \
-d @- << EOF
{}
EOF