# Response attributes Namespace `data` | Parameter | Type | Value | |-------------------------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `id` | String | The ID of the incoming webhook. String representation of a number. | | `type` | String | `incoming_webhook` | | `attributes` | Object | Attributes object. Contains all the incoming webhook attributes. See below. | | `attributes.name` | String | Name of the incoming webhook. | | `attributes.created_at` | String (ISO DateTime format) | When was the incoming webhook created. | | `attributes.updated_at` | String (ISO DateTime format) | When was the incoming webhook last updated. | | `attributes.policy_id` | String | ID of the escalation policy associated with the incoming webhook. String representation of a number. | | `attributes.team_name` | String | The team this integration belongs to. | | `attributes.call` | Boolean | Call the on-call person. | | `attributes.sms` | Boolean | Send an SMS to the on-call person. | | `attributes.email` | Boolean | Send an email to the on-call person. | | `attributes.push` | Boolean | Send a push notification to the on-call person. | | `attributes.critical_alert` | Boolean | Send a critical push notification that ignores the mute switch and Do not Disturb mode. | | `attributes.team_wait` | Integer | How long we wait before escalating the incident alert to the team. In seconds. | | `attributes.recovery_period` | Integer | How long the alert must be up to automatically mark an incident as resolved. In seconds. | | `attributes.url` | String | What's the URL we expect incoming webhooks on. | | `attributes.paused` | Boolean | Whether is the incoming webhook paused. | | `attributes.started_rule_type` | String | Should an incident be started for all incoming webhooks, those satisfying all `acknowledged_rules`, or those satisfying any of them. Valid values are `unused`, `all`, or `any`. | | `attributes.acknowledged_rule_type` | String | Should an incident be acknowledged for all incoming webhooks, those satisfying all `acknowledged_rules`, or those satisfying any of them. Valid values are `unused`, `all`, or `any`. | | `attributes.resolved_rule_type` | String | Should an incident be resolved for all incoming webhooks, those satisfying all `acknowledged_rules`, or those satisfying any of them. Valid values are `unused`, `all`, or `any`. | | `attributes.started_rules.[]` | `Rule` | Array of started rules. See [Rule section](#rule) below for attribute details. | | `attributes.acknowledged_rules.[]` | `Rule` | Array of acknowledged rules. See [Rule section](#rule) below for attribute details. | | `attributes.resolved_rules.[]` | `Rule` | Array of resolved rules. See [Rule section](#rule) below for attribute details. | | `attributes.cause_field` | `Field` | How to extract an incident cause. See [Field section](#field) below for attribute details. | | `attributes.title_field` | `Field` or `null` | How to extract a customized incident title. See [Field section](#field) below for attribute details. Send `null` to remove the field and use default title. | | `attributes.started_alert_id_field` | `Field` | When starting an incident, how to extract an alert id, a unique alert identifier which will be used to acknowledge and resolve incidents. See [Field section](#field) below for attribute details. | | `attributes.acknowledged_alert_id_field` | `Field` | When acknowleding an incident, how to extract an alert id, a unique alert identifier which will be used to acknowledge and resolve incidents. See [Field section](#field) below for attribute details. | | `attributes.resolved_alert_id_field` | `Field` | When resolving an incident, how to extract an alert id, a unique alert identifier which will be used to acknowledge and resolve incidents. See [Field section](#field) below for attribute details. | | `attributes.other_started_fields.[]` | `Field` | Array of additional fields that will be extracted when incident is created. See [Field section](#field) below for attribute details. | | `attributes.other_acknowledged_fields.[]` | `Field` | Array of additional fields that will be extracted when incident is acknowledged. See [Field section](#field) below for attribute details. | | `attributes.other_resolved_fields.[]` | `Field` | Array of additional fields that will be extracted when incident is resolved. See [Field section](#field) below for attribute details. | ### Rule | Parameter | Type | Value | | -------------- | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | `created_at` | String (ISO DateTime format) | When was the rule created. | | `updated_at` | String (ISO DateTime format) | When was the rule last updated. | | `rule_target` | String | The target of the rule. Can be any of the following: `query_string`, `header`, `body`, `json`, or `xml`. | | `match_type` | String | The type of the rule. Can be any of the following: `contains`, `contains_not`, `matches_regex`, `matches_regex_not`, `equals`, or `equals_not`. | | `target_field` | String | The target field of the rule. | | `content` | String | The content we should match to satisfy the rule. Should be a valid Regex when `match_type` is `match_regex`. | ### Field | Parameter | Type | Value | | ---------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | String | The name of the field. | | `special_type` | String | A special type of the field. Can be `alert_id` or `cause` or otherwise `null` for a custom field. | | `field_target` | String | The target of the field. Can be any of the following:`query_string`, `header`, `body`, `json`, or `xml`. | | `match_type` | String | The match type of the field. Can be any of the following: `match_before`, `match_after`, `match_between`, `match_regex`, or `match_everything`. | | `target_field` | String | The target field of the field. | | `content` | String | How should we extract content the field. Should be a valid Regex when `match_type` is `match_regex`. | | `content_before` | String | When should we start extracting content for the field. Should be present when `match_type` is either `match_between` or `match_before`. | | `content_after` | String | When should we start extracting content for the field. Should be present when `match_type` is either `match_between` or `match_after`. |