Note: This endpoint is in preview and is subject to change.
If you have any feedback, contact Datadog support.
POST https://api.ap1.datadoghq.com/api/v2/incidents/config/google-chat-configurationshttps://api.ap2.datadoghq.com/api/v2/incidents/config/google-chat-configurationshttps://api.datadoghq.eu/api/v2/incidents/config/google-chat-configurationshttps://api.ddog-gov.com/api/v2/incidents/config/google-chat-configurationshttps://api.us2.ddog-gov.com/api/v2/incidents/config/google-chat-configurationshttps://api.uk1.datadoghq.com/api/v2/incidents/config/google-chat-configurationshttps://api.datadoghq.com/api/v2/incidents/config/google-chat-configurationshttps://api.us3.datadoghq.com/api/v2/incidents/config/google-chat-configurationshttps://api.us5.datadoghq.com/api/v2/incidents/config/google-chat-configurations
Overview
Create a Google Chat configuration for incidents.
This endpoint requires the incident_settings_write permission.
OAuth apps require the incident_settings_write authorization scope to access this endpoint.
Request
Body Data (required)
Google Chat configuration payload.
Expand All
Google Chat configuration data in a create request.
Attributes for creating a Google Chat configuration.
The Google Chat domain ID.
space_name_template [required]
The template for the Google Chat space name.
space_target_audience_id [required]
The target audience ID for the Google Chat space.
space_time_zone [required]
The time zone for the Google Chat space.
Relationships for a Google Chat configuration create request.
Relationship to an incident type.
Relationship to incident type object.
Incident type resource type.
Allowed enum values: incident_types
default: incident_types
Google Chat configuration resource type.
Allowed enum values: google_chat_configurations
{
"data": {
"attributes": {
"domain_id": "my-domain",
"space_name_template": "{{incident.title}}",
"space_target_audience_id": "123456789",
"space_time_zone": "America/New_York"
},
"relationships": {
"incident_type": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "incident_types"
}
}
},
"type": "google_chat_configurations"
}
}
Response
Created
Response with a Google Chat configuration.
Expand All
Google Chat configuration data in a response.
Attributes of a Google Chat configuration.
Timestamp when the configuration was created.
The Google Chat domain ID.
Timestamp when the configuration was last modified.
space_name_template [required]
The template for the Google Chat space name.
space_target_audience_id [required]
The target audience ID for the Google Chat space.
space_time_zone [required]
The time zone for the Google Chat space.
The configuration identifier.
Relationships for a Google Chat configuration.
Relationship to user object.
A unique identifier that represents the user.
Users resource type.
Allowed enum values: users
default: users
Relationship to an incident type.
Relationship to incident type object.
Incident type resource type.
Allowed enum values: incident_types
default: incident_types
Relationship to user object.
A unique identifier that represents the user.
Users resource type.
Allowed enum values: users
default: users
Google Chat configuration resource type.
Allowed enum values: google_chat_configurations
Included related resources.
Attributes of user object returned by the API.
Users resource type.
Allowed enum values: users
default: users
{
"data": {
"attributes": {
"created_at": "2024-01-01T00:00:00.000Z",
"domain_id": "my-domain",
"modified_at": "2024-01-01T00:00:00.000Z",
"space_name_template": "{{incident.title}}",
"space_target_audience_id": "123456789",
"space_time_zone": "America/New_York"
},
"id": "00000000-0000-0000-0000-000000000000",
"relationships": {
"created_by_user": {
"data": {
"id": "00000000-0000-0000-2345-000000000000",
"type": "users"
}
},
"incident_type": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "incident_types"
}
},
"last_modified_by_user": {
"data": {
"id": "00000000-0000-0000-2345-000000000000",
"type": "users"
}
}
},
"type": "google_chat_configurations"
},
"included": [
{
"attributes": {
"email": "string",
"handle": "string",
"icon": "string",
"name": "string",
"uuid": "string"
},
"id": "string",
"type": "users"
}
]
}
Bad Request
{
"errors": [
"Bad Request"
]
}
Unauthorized
{
"errors": [
"Bad Request"
]
}
Forbidden
{
"errors": [
"Bad Request"
]
}
Too many requests
{
"errors": [
"Bad Request"
]
}
Code Example
## default
#
# Curl command
curl -X POST "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.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/incidents/config/google-chat-configurations" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"data": {
"attributes": {
"domain_id": "my-domain",
"space_name_template": "{{incident.title}}",
"space_target_audience_id": "123456789",
"space_time_zone": "America/New_York"
},
"relationships": {
"incident_type": {
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"type": "incident_types"
}
}
},
"type": "google_chat_configurations"
}
}
EOF
