diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 6d38c854fc8..1e2406bf02e 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -9055,8 +9055,7 @@ menu: - v2 operationids: - CreateEmailTransportWebhookIntake - unstable: - - v2 + unstable: [] order: 1 - name: Entity Risk Scores url: /api/latest/entity-risk-scores/ diff --git a/content/en/api/v2/email-transport/examples.json b/content/en/api/v2/email-transport/examples.json index 4689a8ebdf5..c36a017fcbf 100644 --- a/content/en/api/v2/email-transport/examples.json +++ b/content/en/api/v2/email-transport/examples.json @@ -47,110 +47,13 @@ } }, "request": { - "json_curl": { - "attributes": {}, - "date": "2024-01-15T10:30:00Z", - "log_id": "AQAAAZPHnBT0TwJAdgAAAABBWlBIblVlNEFBQ0dFMmVkYTFDSnRR", - "source": "sendgrid", - "status": "info", - "tags": [ - "env:production" - ] - }, + "json_curl": {}, "json": { - "attributes": { - "category": [ - "transactional" - ], - "email": { - "address": "user@example.com", - "domain": "example.com", - "subject": "[Monitor Alert] CPU usage is high", - "type": [ - "transactional" - ] - }, - "email_id": "abc123-def456", - "email_type_display_name": "Monitor Alert", - "message": { - "auth": { - "delivered_with_tls": "TLSv1.2" - }, - "custom_args": { - "email_id": "abc123-def456", - "email_type_display_name": "Monitor Alert", - "org_uuid": "8dee7c38-00cb-11ea-a77b-8b5a08d3b091", - "queue_time": "2024-01-15T10:29:00Z", - "subject": "[Monitor Alert] CPU usage is high" - }, - "id": { - "message_id": "", - "smtp_id": "", - "transport_event_id": "evt_abc123" - }, - "name": "delivered", - "response": { - "enhanced_smtp_code": "2.0.0", - "reason": "250 2.0.0 OK", - "smtp_code": "250" - }, - "sender_ip": "192.168.1.1", - "timestamp": { - "event_timestamp": 1705312200, - "lifetime": 3.2, - "queue_time": 1.5, - "scheduled_time": 1705312190 - } - }, - "network": { - "ip": { - "attributes": [ - { - "ip": "192.168.1.1", - "source": [ - "sendgrid" - ] - } - ], - "list": [ - "192.168.1.1" - ] - } - }, - "org": 1234, - "org_metadata": { - "billing_country": "string", - "billing_plan": "string", - "customer_tier": "string", - "domain": "string", - "industry": "string", - "is_bugbounty": "string", - "is_msp": "string", - "name": "string", - "org_uuid": "string", - "parent_org_id": "string", - "premium_support": "string", - "root_org_id": "string", - "root_org_name": "string", - "shipping_country": "string", - "website": "string", - "when_created": "string" - }, - "org_uuid": "8dee7c38-00cb-11ea-a77b-8b5a08d3b091", - "queue_time": "2024-01-15T10:29:00Z", - "sg_machine_open": false, - "subject": "[Monitor Alert] CPU usage is high", - "useragent": "Mozilla/5.0" - }, "date": "2024-01-15T10:30:00Z", - "log_id": "AQAAAZPHnBT0TwJAdgAAAABBWlBIblVlNEFBQ0dFMmVkYTFDSnRR", "source": "sendgrid", - "status": "info", - "tags": [ - "env:production" - ] + "status": "info" }, - "html": "
\n
\n
\n
\n

attributes

\n
\n

object

\n

Top-level attributes for the webhook log event, including delivery status, recipient details, and provider metadata.

\n
\n
\n
\n
\n
\n

category

\n
\n

[string]

\n

The event categories.

\n
\n \n
\n
\n
\n
\n
\n

email

\n
\n

object

\n

The email address details.

\n
\n
\n
\n
\n
\n

address

\n
\n

string

\n

The recipient email address.

\n
\n \n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

The recipient domain.

\n
\n \n
\n
\n
\n
\n
\n

subject

\n
\n

string

\n

The email subject line.

\n
\n \n
\n
\n
\n
\n
\n

type

\n
\n

[string]

\n

Email categorization tags applied by the transport provider (for example, "transactional", "marketing").

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

email_id

\n
\n

string

\n

The unique email identifier.

\n
\n \n
\n
\n
\n
\n
\n

email_type_display_name

\n
\n

string

\n

The human-readable email type name.

\n
\n \n
\n
\n
\n
\n
\n

message

\n
\n

object

\n

The message delivery event details.

\n
\n
\n
\n
\n
\n

auth

\n
\n

object

\n

The message authentication details.

\n
\n
\n
\n
\n
\n

delivered_with_tls

\n
\n

string

\n

The TLS version or negotiation information.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

custom_args

\n
\n

object

\n

Custom arguments passed through the email transport provider for tracking.

\n
\n
\n
\n
\n
\n

email_id

\n
\n

string

\n

The unique email identifier.

\n
\n \n
\n
\n
\n
\n
\n

email_type_display_name

\n
\n

string

\n

The human-readable email type name.

\n
\n \n
\n
\n
\n
\n
\n

org_uuid

\n
\n

string

\n

The organization UUID.

\n
\n \n
\n
\n
\n
\n
\n

queue_time

\n
\n

string

\n

The timestamp when the email was queued.

\n
\n \n
\n
\n
\n
\n
\n

subject

\n
\n

string

\n

The email subject line.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id

\n
\n

object

\n

The message identifiers.

\n
\n
\n
\n
\n
\n

message_id

\n
\n

string

\n

The RFC 5322 Message-ID.

\n
\n \n
\n
\n
\n
\n
\n

smtp_id

\n
\n

string

\n

The SMTP transaction identifier.

\n
\n \n
\n
\n
\n
\n
\n

transport_event_id

\n
\n

string

\n

The transport provider event identifier.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

The delivery event type emitted by the transport provider (for example, "delivered", "dropped", "bounced").

\n
\n \n
\n
\n
\n
\n
\n

response

\n
\n

object

\n

The SMTP response information.

\n
\n
\n
\n
\n
\n

enhanced_smtp_code

\n
\n

string

\n

The enhanced SMTP status code.

\n
\n \n
\n
\n
\n
\n
\n

reason

\n
\n

string

\n

The SMTP response message.

\n
\n \n
\n
\n
\n
\n
\n

smtp_code

\n
\n

string

\n

The SMTP status code.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sender_ip

\n
\n

string

\n

The IP address of the sending server.

\n
\n \n
\n
\n
\n
\n
\n

timestamp

\n
\n

object

\n

The message delivery timing information.

\n
\n
\n
\n
\n
\n

event_timestamp

\n
\n

double

\n

The Unix timestamp of the event.

\n
\n \n
\n
\n
\n
\n
\n

lifetime

\n
\n

double

\n

The total delivery time in seconds.

\n
\n \n
\n
\n
\n
\n
\n

queue_time

\n
\n

double

\n

Number of seconds the message spent in the delivery queue.

\n
\n \n
\n
\n
\n
\n
\n

scheduled_time

\n
\n

double

\n

The scheduled delivery time as a Unix timestamp.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

network

\n
\n

object

\n

The network information for the event.

\n
\n
\n
\n
\n
\n

ip

\n
\n

object

\n

The IP address information.

\n
\n
\n
\n
\n
\n

attributes

\n
\n

[object]

\n

Per-IP attribute records, each pairing an IP address with the providers that observed it.

\n
\n
\n
\n
\n
\n

ip

\n
\n

string

\n

The IP address.

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

[string]

\n

The transport providers or systems that reported this IP address.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

list

\n
\n

[string]

\n

The list of IP addresses.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

org

\n
\n

int64

\n

The numeric organization identifier.

\n
\n \n
\n
\n
\n
\n
\n

org_metadata

\n
\n

object

\n

Metadata about the organization that sent the email.

\n
\n
\n
\n
\n
\n

billing_country

\n
\n

string

\n

Country code or name used for billing purposes.

\n
\n \n
\n
\n
\n
\n
\n

billing_plan

\n
\n

string

\n

The Datadog billing plan for the organization (for example, "pro", "enterprise").

\n
\n \n
\n
\n
\n
\n
\n

customer_tier

\n
\n

string

\n

Support or account tier assigned to the organization (for example, "tier-1").

\n
\n \n
\n
\n
\n
\n
\n

domain

\n
\n

string

\n

Primary email domain associated with the organization (for example, "example.com").

\n
\n \n
\n
\n
\n
\n
\n

industry

\n
\n

string

\n

Industry classification of the organization (for example, "technology", "finance").

\n
\n \n
\n
\n
\n
\n
\n

is_bugbounty

\n
\n

string

\n

Whether the organization is enrolled in the Datadog bug bounty program.

\n
\n \n
\n
\n
\n
\n
\n

is_msp

\n
\n

string

\n

Whether the organization operates as a Managed Service Provider managing child orgs.

\n
\n \n
\n
\n
\n
\n
\n

name

\n
\n

string

\n

Display name of the organization as configured in Datadog account settings.

\n
\n \n
\n
\n
\n
\n
\n

org_uuid

\n
\n

string

\n

Globally unique identifier for the Datadog organization (UUID v1 format).

\n
\n \n
\n
\n
\n
\n
\n

parent_org_id

\n
\n

string

\n

Identifier of the immediate parent organization, if this is a child org.

\n
\n \n
\n
\n
\n
\n
\n

premium_support

\n
\n

string

\n

Whether the organization has a premium support plan with Datadog.

\n
\n \n
\n
\n
\n
\n
\n

root_org_id

\n
\n

string

\n

Identifier of the top-level parent organization in a multi-org account hierarchy.

\n
\n \n
\n
\n
\n
\n
\n

root_org_name

\n
\n

string

\n

Display name of the top-level parent organization in a multi-org account hierarchy.

\n
\n \n
\n
\n
\n
\n
\n

shipping_country

\n
\n

string

\n

Country code or name used for shipping or regional assignment.

\n
\n \n
\n
\n
\n
\n
\n

website

\n
\n

string

\n

Website URL provided during organization registration.

\n
\n \n
\n
\n
\n
\n
\n

when_created

\n
\n

string

\n

ISO 8601 timestamp of when the Datadog organization was created.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

org_uuid

\n
\n

string

\n

The organization UUID.

\n
\n \n
\n
\n
\n
\n
\n

queue_time

\n
\n

string

\n

The timestamp when the email was queued.

\n
\n \n
\n
\n
\n
\n
\n

sg_machine_open

\n
\n

boolean

\n

Indicates whether the open event was triggered by automated machine activity rather than a human recipient (SendGrid-specific).

\n
\n \n
\n
\n
\n
\n
\n

subject

\n
\n

string

\n

The email subject line.

\n
\n \n
\n
\n
\n
\n
\n

useragent

\n
\n

string

\n

The user agent string for open events.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

date

\n
\n

date-time

\n

The ISO 8601 timestamp of the event.

\n
\n \n
\n
\n
\n
\n
\n

log_id

\n
\n

string

\n

The unique log event identifier.

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

string

\n

The email transport provider.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The log status level.

\n
\n \n
\n
\n
\n
\n
\n

tags

\n
\n

[string]

\n

A list of tags associated with the event.

\n
\n \n
\n
" + "html": "
\n
\n
\n
\n

date

\n
\n

date-time

\n

The ISO 8601 timestamp of the event.

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

string

\n

The email transport provider.

\n
\n \n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

The log status level.

\n
\n \n
\n
" } } } \ No newline at end of file diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index 04414bb3292..868d3be6f99 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -79428,17 +79428,11 @@ components: TransportWebhookLog: description: A single email transport webhook log event. properties: - attributes: - $ref: "#/components/schemas/TransportWebhookLogAttributes" date: description: The ISO 8601 timestamp of the event. example: "2024-01-15T10:30:00Z" format: date-time type: string - log_id: - description: The unique log event identifier. - example: "AQAAAZPHnBT0TwJAdgAAAABBWlBIblVlNEFBQ0dFMmVkYTFDSnRR" - type: string source: description: The email transport provider. example: "sendgrid" @@ -79447,299 +79441,12 @@ components: description: The log status level. example: "info" type: string - tags: - description: A list of tags associated with the event. - example: ["env:production"] - items: - description: A tag in key:value or key-only form (for example, env:production). - type: string - type: array - required: - - date - - log_id - - source - - status - - tags - - attributes - type: object - TransportWebhookLogAttributes: - description: Top-level attributes for the webhook log event, including delivery status, recipient details, and provider metadata. - properties: - category: - description: The event categories. - example: ["transactional"] - items: - description: An event category assigned by the transport provider. - type: string - type: array - email: - $ref: "#/components/schemas/TransportWebhookLogEmail" - email_id: - description: The unique email identifier. - example: "abc123-def456" - type: string - email_type_display_name: - description: The human-readable email type name. - example: "Monitor Alert" - type: string - message: - $ref: "#/components/schemas/TransportWebhookLogMessage" - network: - $ref: "#/components/schemas/TransportWebhookLogNetwork" - org: - description: The numeric organization identifier. - example: 1234 - format: int64 - type: integer - org_metadata: - $ref: "#/components/schemas/TransportWebhookLogOrgMetadata" - org_uuid: - description: The organization UUID. - example: "8dee7c38-00cb-11ea-a77b-8b5a08d3b091" - type: string - queue_time: - description: The timestamp when the email was queued. - example: "2024-01-15T10:29:00Z" - type: string - sg_machine_open: - description: Indicates whether the open event was triggered by automated machine activity rather than a human recipient (SendGrid-specific). - type: boolean - subject: - description: The email subject line. - example: "[Monitor Alert] CPU usage is high" - type: string - useragent: - description: The user agent string for open events. - example: "Mozilla/5.0" - type: string type: object TransportWebhookLogBatchRequest: description: A batch of email transport webhook log events. items: $ref: "#/components/schemas/TransportWebhookLog" type: array - TransportWebhookLogEmail: - description: The email address details. - properties: - address: - description: The recipient email address. - example: "user@example.com" - type: string - domain: - description: The recipient domain. - example: "example.com" - type: string - subject: - description: The email subject line. - example: "[Monitor Alert] CPU usage is high" - type: string - type: - description: Email categorization tags applied by the transport provider (for example, "transactional", "marketing"). - example: ["transactional"] - items: - description: An email type classification (for example, "transactional", "user"). - type: string - type: array - type: object - TransportWebhookLogIpAttribute: - description: An IP attribute with its sources. - properties: - ip: - description: The IP address. - example: "192.168.1.1" - type: string - source: - description: The transport providers or systems that reported this IP address. - example: ["sendgrid"] - items: - description: A transport provider or system that reported this IP address. - type: string - type: array - type: object - TransportWebhookLogMessage: - description: The message delivery event details. - properties: - auth: - $ref: "#/components/schemas/TransportWebhookLogMessageAuth" - custom_args: - $ref: "#/components/schemas/TransportWebhookLogMessageCustomArgs" - id: - $ref: "#/components/schemas/TransportWebhookLogMessageId" - name: - description: The delivery event type emitted by the transport provider (for example, "delivered", "dropped", "bounced"). - example: "delivered" - type: string - response: - $ref: "#/components/schemas/TransportWebhookLogMessageResponse" - sender_ip: - description: The IP address of the sending server. - example: "192.168.1.1" - type: string - timestamp: - $ref: "#/components/schemas/TransportWebhookLogMessageTimestamp" - type: object - TransportWebhookLogMessageAuth: - description: The message authentication details. - properties: - delivered_with_tls: - description: The TLS version or negotiation information. - example: "TLSv1.2" - type: string - type: object - TransportWebhookLogMessageCustomArgs: - description: Custom arguments passed through the email transport provider for tracking. - properties: - email_id: - description: The unique email identifier. - example: "abc123-def456" - type: string - email_type_display_name: - description: The human-readable email type name. - example: "Monitor Alert" - type: string - org_uuid: - description: The organization UUID. - example: "8dee7c38-00cb-11ea-a77b-8b5a08d3b091" - type: string - queue_time: - description: The timestamp when the email was queued. - example: "2024-01-15T10:29:00Z" - type: string - subject: - description: The email subject line. - example: "[Monitor Alert] CPU usage is high" - type: string - type: object - TransportWebhookLogMessageId: - description: The message identifiers. - properties: - message_id: - description: The RFC 5322 Message-ID. - example: "" - type: string - smtp_id: - description: The SMTP transaction identifier. - example: "" - type: string - transport_event_id: - description: The transport provider event identifier. - example: "evt_abc123" - type: string - type: object - TransportWebhookLogMessageResponse: - description: The SMTP response information. - properties: - enhanced_smtp_code: - description: The enhanced SMTP status code. - example: "2.0.0" - type: string - reason: - description: The SMTP response message. - example: "250 2.0.0 OK" - type: string - smtp_code: - description: The SMTP status code. - example: "250" - type: string - type: object - TransportWebhookLogMessageTimestamp: - description: The message delivery timing information. - properties: - event_timestamp: - description: The Unix timestamp of the event. - example: 1705312200.0 - format: double - type: number - lifetime: - description: The total delivery time in seconds. - example: 3.2 - format: double - type: number - queue_time: - description: Number of seconds the message spent in the delivery queue. - example: 1.5 - format: double - type: number - scheduled_time: - description: The scheduled delivery time as a Unix timestamp. - example: 1705312190.0 - format: double - type: number - type: object - TransportWebhookLogNetwork: - description: The network information for the event. - properties: - ip: - $ref: "#/components/schemas/TransportWebhookLogNetworkIp" - type: object - TransportWebhookLogNetworkIp: - description: The IP address information. - properties: - attributes: - description: Per-IP attribute records, each pairing an IP address with the providers that observed it. - items: - $ref: "#/components/schemas/TransportWebhookLogIpAttribute" - type: array - list: - description: The list of IP addresses. - example: ["192.168.1.1"] - items: - description: An IP address observed during message delivery. - type: string - type: array - type: object - TransportWebhookLogOrgMetadata: - description: Metadata about the organization that sent the email. - properties: - billing_country: - description: Country code or name used for billing purposes. - type: string - billing_plan: - description: The Datadog billing plan for the organization (for example, "pro", "enterprise"). - type: string - customer_tier: - description: Support or account tier assigned to the organization (for example, "tier-1"). - type: string - domain: - description: Primary email domain associated with the organization (for example, "example.com"). - type: string - industry: - description: Industry classification of the organization (for example, "technology", "finance"). - type: string - is_bugbounty: - description: Whether the organization is enrolled in the Datadog bug bounty program. - type: string - is_msp: - description: Whether the organization operates as a Managed Service Provider managing child orgs. - type: string - name: - description: Display name of the organization as configured in Datadog account settings. - type: string - org_uuid: - description: Globally unique identifier for the Datadog organization (UUID v1 format). - type: string - parent_org_id: - description: Identifier of the immediate parent organization, if this is a child org. - type: string - premium_support: - description: Whether the organization has a premium support plan with Datadog. - type: string - root_org_id: - description: Identifier of the top-level parent organization in a multi-org account hierarchy. - type: string - root_org_name: - description: Display name of the top-level parent organization in a multi-org account hierarchy. - type: string - shipping_country: - description: Country code or name used for shipping or regional assignment. - type: string - website: - description: Website URL provided during organization registration. - type: string - when_created: - description: ISO 8601 timestamp of when the Datadog organization was created. - type: string - type: object Trigger: description: "One of the triggers that can start the execution of a workflow." oneOf: @@ -100117,10 +99824,7 @@ paths: - monitors_downtime /api/v2/email/transport/webhook_intake: post: - description: |- - Receives a batch of email transport webhook log events and emits an audit trail entry - for each event with a final delivery status (delivered, dropped, or bounced). - Only authorized organizations can submit events. + deprecated: true operationId: CreateEmailTransportWebhookIntake requestBody: content: @@ -100128,31 +99832,9 @@ paths: examples: default: value: - - attributes: - email: - address: "user@example.com" - domain: "example.com" - email_id: "abc123-def456" - email_type_display_name: "Monitor Alert" - message: - id: - message_id: "" - smtp_id: "" - name: "delivered" - response: - reason: "250 2.0.0 OK" - smtp_code: "250" - timestamp: - event_timestamp: 1705312200.0 - org: 1234 - org_uuid: "8dee7c38-00cb-11ea-a77b-8b5a08d3b091" - subject: "[Monitor Alert] CPU usage is high" - date: "2024-01-15T10:30:00Z" - log_id: "AQAAAZPHnBT0TwJAdgAAAABBWlBIblVlNEFBQ0dFMmVkYTFDSnRR" + - date: "2024-01-15T10:30:00Z" source: "sendgrid" status: "info" - tags: - - "env:production" schema: $ref: "#/components/schemas/TransportWebhookLogBatchRequest" required: true @@ -100177,9 +99859,7 @@ paths: tags: - Email Transport x-menu-order: 1 - x-unstable: |- - **Note**: This endpoint is in preview and is subject to change. - If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). + x-sunset: "2027-01-01" /api/v2/error-tracking/issues/search: post: description: Search issues endpoint allows you to programmatically search for issues within your organization. This endpoint returns a list of issues that match a given search query, following the event search syntax. The search results are limited to a maximum of 100 issues per request. diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index 23ddd5059f3..909defbed00 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -1309,7 +1309,6 @@ "request_schema_description": "Request for editing a downtime." }, "CreateEmailTransportWebhookIntake": { - "description": "Receives a batch of email transport webhook log events and emits an audit trail entry\nfor each event with a final delivery status (delivered, dropped, or bounced).\nOnly authorized organizations can submit events.", "summary": "Ingest email transport webhook events", "request_description": "", "request_schema_description": "A batch of email transport webhook log events."