- 필수 기능
- 시작하기
- Glossary
- 표준 속성
- Guides
- Agent
- 통합
- 개방형텔레메트리
- 개발자
- Administrator's Guide
- API
- Datadog Mobile App
- CoScreen
- Cloudcraft
- 앱 내
- 서비스 관리
- 인프라스트럭처
- 애플리케이션 성능
- APM
- Continuous Profiler
- 스팬 시각화
- 데이터 스트림 모니터링
- 데이터 작업 모니터링
- 디지털 경험
- 소프트웨어 제공
- 보안
- AI Observability
- 로그 관리
- 관리
Datadog API를 통해 바로 Datadog-Webhooks 통합을 구성하세요. 자세한 정보는 Webhooks 통합 페이지를 참고하세요.
POST https://api.ap1.datadoghq.com/api/v1/integration/webhooks/configuration/webhookshttps://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/webhookshttps://api.us5.datadoghq.com/api/v1/integration/webhooks/configuration/webhooks
Creates an endpoint with the name <WEBHOOK_NAME>
.
This endpoint requires the create_webhooks
permission.
OAuth apps require the create_webhooks
authorization scope to access this endpoint.
Create a webhooks integration request body.
{
"name": "Example-Webhooks-Integration",
"url": "https://example.com/webhook"
}
OK
Datadog-Webhooks integration.
{
"custom_headers": "string",
"encode_as": "string",
"name": "WEBHOOK_NAME",
"payload": "string",
"url": "https://example.com/webhook"
}
Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}
Authentication error
Error response object.
{
"errors": [
"Bad Request"
]
}
Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
/**
* Create a webhooks integration returns "OK" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.WebhooksIntegrationApi(configuration);
const params: v1.WebhooksIntegrationApiCreateWebhooksIntegrationRequest = {
body: {
name: "Example-Webhooks-Integration",
url: "https://example.com/webhook",
},
};
apiInstance
.createWebhooksIntegration(params)
.then((data: v1.WebhooksIntegration) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"
GET https://api.ap1.datadoghq.com/api/v1/integration/webhooks/configuration/webhooks/{webhook_name}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}https://api.us5.datadoghq.com/api/v1/integration/webhooks/configuration/webhooks/{webhook_name}
Gets the content of the webhook with the name <WEBHOOK_NAME>
.
This endpoint requires the integrations_read
permission.
이름
유형
설명
webhook_name [required]
string
The name of the webhook.
OK
Datadog-Webhooks integration.
{
"custom_headers": "string",
"encode_as": "string",
"name": "WEBHOOK_NAME",
"payload": "string",
"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"
]
}
Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
/**
* Get a webhook integration returns "OK" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.WebhooksIntegrationApi(configuration);
// there is a valid "webhook" in the system
const WEBHOOK_NAME = process.env.WEBHOOK_NAME as string;
const params: v1.WebhooksIntegrationApiGetWebhooksIntegrationRequest = {
webhookName: WEBHOOK_NAME,
};
apiInstance
.getWebhooksIntegration(params)
.then((data: v1.WebhooksIntegration) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
PUT https://api.ap1.datadoghq.com/api/v1/integration/webhooks/configuration/webhooks/{webhook_name}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}https://api.us5.datadoghq.com/api/v1/integration/webhooks/configuration/webhooks/{webhook_name}
Updates the endpoint with the name <WEBHOOK_NAME>
.
This endpoint requires the manage_integrations
permission.
이름
유형
설명
webhook_name [required]
string
The name of the webhook.
Update an existing Datadog-Webhooks integration.
{
"url": "https://example.com/webhook-updated"
}
OK
Datadog-Webhooks integration.
{
"custom_headers": "string",
"encode_as": "string",
"name": "WEBHOOK_NAME",
"payload": "string",
"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"
]
}
Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
/**
* Update a webhook returns "OK" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.WebhooksIntegrationApi(configuration);
// there is a valid "webhook" in the system
const WEBHOOK_NAME = process.env.WEBHOOK_NAME as string;
const params: v1.WebhooksIntegrationApiUpdateWebhooksIntegrationRequest = {
body: {
url: "https://example.com/webhook-updated",
},
webhookName: WEBHOOK_NAME,
};
apiInstance
.updateWebhooksIntegration(params)
.then((data: v1.WebhooksIntegration) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
DELETE https://api.ap1.datadoghq.com/api/v1/integration/webhooks/configuration/webhooks/{webhook_name}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}https://api.us5.datadoghq.com/api/v1/integration/webhooks/configuration/webhooks/{webhook_name}
Deletes the endpoint with the name <WEBHOOK NAME>
.
This endpoint requires the manage_integrations
permission.
이름
유형
설명
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"
]
}
Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
/**
* Delete a webhook returns "OK" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.WebhooksIntegrationApi(configuration);
// there is a valid "webhook" in the system
const WEBHOOK_NAME = process.env.WEBHOOK_NAME as string;
const params: v1.WebhooksIntegrationApiDeleteWebhooksIntegrationRequest = {
webhookName: WEBHOOK_NAME,
};
apiInstance
.deleteWebhooksIntegration(params)
.then((data: any) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
POST https://api.ap1.datadoghq.com/api/v1/integration/webhooks/configuration/custom-variableshttps://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-variableshttps://api.us5.datadoghq.com/api/v1/integration/webhooks/configuration/custom-variables
Creates an endpoint with the name <CUSTOM_VARIABLE_NAME>
.
This endpoint requires the manage_integrations
permission.
Define a custom variable request body.
{
"is_secret": true,
"name": "EXAMPLEWEBHOOKSINTEGRATION",
"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"
]
}
Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
/**
* Create a custom variable returns "OK" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.WebhooksIntegrationApi(configuration);
const params: v1.WebhooksIntegrationApiCreateWebhooksIntegrationCustomVariableRequest =
{
body: {
isSecret: true,
name: "EXAMPLEWEBHOOKSINTEGRATION",
value: "CUSTOM_VARIABLE_VALUE",
},
};
apiInstance
.createWebhooksIntegrationCustomVariable(params)
.then((data: v1.WebhooksIntegrationCustomVariableResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
GET https://api.ap1.datadoghq.com/api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}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}https://api.us5.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, the value does not return in the response payload.
This endpoint requires theintegrations_read
permission.이름
유형
설명
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"
]
}
Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
/**
* Get a custom variable returns "OK" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.WebhooksIntegrationApi(configuration);
const params: v1.WebhooksIntegrationApiGetWebhooksIntegrationCustomVariableRequest =
{
customVariableName: "custom_variable_name",
};
apiInstance
.getWebhooksIntegrationCustomVariable(params)
.then((data: v1.WebhooksIntegrationCustomVariableResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
PUT https://api.ap1.datadoghq.com/api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}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}https://api.us5.datadoghq.com/api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}
Updates the endpoint with the name <CUSTOM_VARIABLE_NAME>
.
This endpoint requires the manage_integrations
permission.
이름
유형
설명
custom_variable_name [required]
string
The name of the custom variable.
Update an existing custom variable request body.
{
"value": "variable-updated"
}
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"
]
}
Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
/**
* Update a custom variable returns "OK" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.WebhooksIntegrationApi(configuration);
// there is a valid "webhook_custom_variable" in the system
const WEBHOOK_CUSTOM_VARIABLE_NAME = process.env
.WEBHOOK_CUSTOM_VARIABLE_NAME as string;
const params: v1.WebhooksIntegrationApiUpdateWebhooksIntegrationCustomVariableRequest =
{
body: {
value: "variable-updated",
},
customVariableName: WEBHOOK_CUSTOM_VARIABLE_NAME,
};
apiInstance
.updateWebhooksIntegrationCustomVariable(params)
.then((data: v1.WebhooksIntegrationCustomVariableResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
DELETE https://api.ap1.datadoghq.com/api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}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}https://api.us5.datadoghq.com/api/v1/integration/webhooks/configuration/custom-variables/{custom_variable_name}
Deletes the endpoint with the name <CUSTOM_VARIABLE_NAME>
.
This endpoint requires the manage_integrations
permission.
이름
유형
설명
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"
]
}
Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
/**
* Delete a custom variable returns "OK" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.WebhooksIntegrationApi(configuration);
// there is a valid "webhook_custom_variable" in the system
const WEBHOOK_CUSTOM_VARIABLE_NAME = process.env
.WEBHOOK_CUSTOM_VARIABLE_NAME as string;
const params: v1.WebhooksIntegrationApiDeleteWebhooksIntegrationCustomVariableRequest =
{
customVariableName: WEBHOOK_CUSTOM_VARIABLE_NAME,
};
apiInstance
.deleteWebhooksIntegrationCustomVariable(params)
.then((data: any) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"