POST   alerts/recipient

Creates a new recipient with two targets: one SMS and one email.

Remarks

By default two or more recipients cannot have the same name. Use the request query parameter allow_duplicates to override this.

Returns HTTP 201 Created when succesful. The Location header contains an URL to the new alert recipient).

Request example and description

curl --request POST "https://api-asm1.apica.io/v3/alerts/recipient?auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E" --header "Content-Type: application/json" --data-raw "{
  \"name\": \"My target\",
  \"description\": \"Description\",
  \"phone\": \"+01234567890\",
  \"phone_description\": \"My phone\",
  \"email\": \"target@email.com\",
  \"email_description\": \"My e-mail\",
  \"service_name\": [
    \"WebHook alert service name\"
  ],
  \"slack_configuration\": {
    \"ApiId\": \"slack url\",
    \"Channel\": \"slack channel\",
    \"Title\": \"alert title\",
    \"Message\": \"alert message\"
  },
  \"splunk_configuration\": {
    \"Username\": \"splunk username\",
    \"Password\": \"splunk password\",
    \"Host\": \"host\",
    \"MessageType\": \"message source\",
    \"Title\": \"alert title\",
    \"Message\": \"alert message\"
  },
  \"service_now_configuration\": {
    \"Host\": \"host\",
    \"ClientId\": \"client ID\",
    \"ClientSecret\": \"client secret\",
    \"Username\": \"client username\",
    \"Password\": \"client password\",
    \"Title\": \"description\",
    \"Caller\": \"caller\",
    \"TriggerParams\": [
      {
        \"Key\": \"sample string 1\",
        \"Value\": \"sample string 2\"
      },
      {
        \"Key\": \"sample string 1\",
        \"Value\": \"sample string 2\"
      },
      {
        \"Key\": \"sample string 1\",
        \"Value\": \"sample string 2\"
      }
    ],
    \"ResolveParams\": [
      {
        \"Key\": \"sample string 1\",
        \"Value\": \"sample string 2\"
      },
      {
        \"Key\": \"sample string 1\",
        \"Value\": \"sample string 2\"
      },
      {
        \"Key\": \"sample string 1\",
        \"Value\": \"sample string 2\"
      }
    ]
  },
  \"ops_genie_configuration\": {
    \"Host\": \"host\",
    \"ApiKey\": \"apikey\",
    \"Message\": \"message\",
    \"Alias\": \"alias\",
    \"Description\": \"description\",
    \"Teams\": [
      {
        \"IdType\": \"sample string 1\",
        \"Name\": \"sample string 2\",
        \"Type\": \"sample string 3\",
        \"Key\": \"sample string 4\"
      },
      {
        \"IdType\": \"sample string 1\",
        \"Name\": \"sample string 2\",
        \"Type\": \"sample string 3\",
        \"Key\": \"sample string 4\"
      },
      {
        \"IdType\": \"sample string 1\",
        \"Name\": \"sample string 2\",
        \"Type\": \"sample string 3\",
        \"Key\": \"sample string 4\"
      }
    ],
    \"VisibleTo\": [
      {
        \"IdType\": \"sample string 1\",
        \"Name\": \"sample string 2\",
        \"Type\": \"sample string 3\",
        \"Key\": \"sample string 4\"
      },
      {
        \"IdType\": \"sample string 1\",
        \"Name\": \"sample string 2\",
        \"Type\": \"sample string 3\",
        \"Key\": \"sample string 4\"
      },
      {
        \"IdType\": \"sample string 1\",
        \"Name\": \"sample string 2\",
        \"Type\": \"sample string 3\",
        \"Key\": \"sample string 4\"
      }
    ],
    \"Actions\": [
      {
        \"IdType\": \"sample string 1\",
        \"Name\": \"sample string 2\",
        \"Type\": \"sample string 3\",
        \"Key\": \"sample string 4\"
      },
      {
        \"IdType\": \"sample string 1\",
        \"Name\": \"sample string 2\",
        \"Type\": \"sample string 3\",
        \"Key\": \"sample string 4\"
      },
      {
        \"IdType\": \"sample string 1\",
        \"Name\": \"sample string 2\",
        \"Type\": \"sample string 3\",
        \"Key\": \"sample string 4\"
      }
    ],
    \"Tags\": [
      {
        \"IdType\": \"sample string 1\",
        \"Name\": \"sample string 2\",
        \"Type\": \"sample string 3\",
        \"Key\": \"sample string 4\"
      },
      {
        \"IdType\": \"sample string 1\",
        \"Name\": \"sample string 2\",
        \"Type\": \"sample string 3\",
        \"Key\": \"sample string 4\"
      },
      {
        \"IdType\": \"sample string 1\",
        \"Name\": \"sample string 2\",
        \"Type\": \"sample string 3\",
        \"Key\": \"sample string 4\"
      }
    ],
    \"Details\": [
      {
        \"IdType\": \"sample string 1\",
        \"Name\": \"sample string 2\",
        \"Type\": \"sample string 3\",
        \"Key\": \"sample string 4\"
      },
      {
        \"IdType\": \"sample string 1\",
        \"Name\": \"sample string 2\",
        \"Type\": \"sample string 3\",
        \"Key\": \"sample string 4\"
      },
      {
        \"IdType\": \"sample string 1\",
        \"Name\": \"sample string 2\",
        \"Type\": \"sample string 3\",
        \"Key\": \"sample string 4\"
      }
    ],
    \"Entity\": \"entity\",
    \"Source\": \"source\",
    \"Priority\": \"priority\",
    \"User\": \"user\",
    \"Note\": \"note\"
  },
  \"custom_configuration\": {
    \"ServiceName\": \"service_name\",
    \"AuthenticationParams\": {
      \"Method\": \"method\",
      \"ClientId\": \"client_id\",
      \"ClientSecret\": \"client_secret\",
      \"Username\": \"username\",
      \"Password\": \"password\",
      \"AccessTokenName\": \"access_token_name\",
      \"RefreshTokenName\": \"refresh_token_name\"
    },
    \"EndpointParams\": {
      \"AuthenticationUrl\": \"authentication url\",
      \"AuthenticationMethod\": \"authentication method\",
      \"ResponseParams\": [
        {
          \"Id\": 1,
          \"ResponseParameterXpath\": \"sample string 2\",
          \"Placeholder\": \"sample string 3\",
          \"Expiring\": true
        },
        {
          \"Id\": 1,
          \"ResponseParameterXpath\": \"sample string 2\",
          \"Placeholder\": \"sample string 3\",
          \"Expiring\": true
        },
        {
          \"Id\": 1,
          \"ResponseParameterXpath\": \"sample string 2\",
          \"Placeholder\": \"sample string 3\",
          \"Expiring\": true
        }
      ],
      \"ParameterDefinitions\": [
        {
          \"Id\": 1,
          \"IsTrigger\": true,
          \"IsResolve\": true,
          \"IsAccessToken\": true,
          \"IsRefreshToken\": true,
          \"IsIntermediate\": true,
          \"Name\": \"sample string 7\",
          \"Value\": \"sample string 8\",
          \"Placeholder\": \"sample string 9\"
        },
        {
          \"Id\": 1,
          \"IsTrigger\": true,
          \"IsResolve\": true,
          \"IsAccessToken\": true,
          \"IsRefreshToken\": true,
          \"IsIntermediate\": true,
          \"Name\": \"sample string 7\",
          \"Value\": \"sample string 8\",
          \"Placeholder\": \"sample string 9\"
        },
        {
          \"Id\": 1,
          \"IsTrigger\": true,
          \"IsResolve\": true,
          \"IsAccessToken\": true,
          \"IsRefreshToken\": true,
          \"IsIntermediate\": true,
          \"Name\": \"sample string 7\",
          \"Value\": \"sample string 8\",
          \"Placeholder\": \"sample string 9\"
        }
      ],
      \"TriggerPayloadParams\": [
        {
          \"Id\": 1,
          \"ContentType\": \"sample string 2\",
          \"Data\": \"sample string 3\",
          \"Severities\": \"sample string 4\"
        },
        {
          \"Id\": 1,
          \"ContentType\": \"sample string 2\",
          \"Data\": \"sample string 3\",
          \"Severities\": \"sample string 4\"
        },
        {
          \"Id\": 1,
          \"ContentType\": \"sample string 2\",
          \"Data\": \"sample string 3\",
          \"Severities\": \"sample string 4\"
        }
      ],
      \"ResolvePayloadParam\": {
        \"Id\": 1,
        \"ContentType\": \"sample string 2\",
        \"Data\": \"sample string 3\",
        \"Severities\": \"sample string 4\"
      },
      \"TriggerUrl\": \"trigger url\",
      \"TriggerMethod\": \"trigger method\",
      \"ResolveUrl\": \"resolve url\",
      \"ResolveMethod\": \"resolve method\",
      \"TriggerSubRequests\": [
        {
          \"Url\": \"sample string 1\",
          \"Method\": \"sample string 2\",
          \"Repeat\": true,
          \"Condition\": \"sample string 4\",
          \"Headers\": [
            {
              \"Name\": \"sample string 1\",
              \"Value\": \"sample string 2\"
            },
            {
              \"Name\": \"sample string 1\",
              \"Value\": \"sample string 2\"
            },
            {
              \"Name\": \"sample string 1\",
              \"Value\": \"sample string 2\"
            }
          ]
        },
        {
          \"Url\": \"sample string 1\",
          \"Method\": \"sample string 2\",
          \"Repeat\": true,
          \"Condition\": \"sample string 4\",
          \"Headers\": [
            {
              \"Name\": \"sample string 1\",
              \"Value\": \"sample string 2\"
            },
            {
              \"Name\": \"sample string 1\",
              \"Value\": \"sample string 2\"
            },
            {
              \"Name\": \"sample string 1\",
              \"Value\": \"sample string 2\"
            }
          ]
        },
        {
          \"Url\": \"sample string 1\",
          \"Method\": \"sample string 2\",
          \"Repeat\": true,
          \"Condition\": \"sample string 4\",
          \"Headers\": [
            {
              \"Name\": \"sample string 1\",
              \"Value\": \"sample string 2\"
            },
            {
              \"Name\": \"sample string 1\",
              \"Value\": \"sample string 2\"
            },
            {
              \"Name\": \"sample string 1\",
              \"Value\": \"sample string 2\"
            }
          ]
        }
      ],
      \"ResolveSubRequests\": [
        {
          \"Url\": \"sample string 1\",
          \"Method\": \"sample string 2\",
          \"Repeat\": true,
          \"Condition\": \"sample string 4\",
          \"Headers\": [
            {
              \"Name\": \"sample string 1\",
              \"Value\": \"sample string 2\"
            },
            {
              \"Name\": \"sample string 1\",
              \"Value\": \"sample string 2\"
            },
            {
              \"Name\": \"sample string 1\",
              \"Value\": \"sample string 2\"
            }
          ]
        },
        {
          \"Url\": \"sample string 1\",
          \"Method\": \"sample string 2\",
          \"Repeat\": true,
          \"Condition\": \"sample string 4\",
          \"Headers\": [
            {
              \"Name\": \"sample string 1\",
              \"Value\": \"sample string 2\"
            },
            {
              \"Name\": \"sample string 1\",
              \"Value\": \"sample string 2\"
            },
            {
              \"Name\": \"sample string 1\",
              \"Value\": \"sample string 2\"
            }
          ]
        },
        {
          \"Url\": \"sample string 1\",
          \"Method\": \"sample string 2\",
          \"Repeat\": true,
          \"Condition\": \"sample string 4\",
          \"Headers\": [
            {
              \"Name\": \"sample string 1\",
              \"Value\": \"sample string 2\"
            },
            {
              \"Name\": \"sample string 1\",
              \"Value\": \"sample string 2\"
            },
            {
              \"Name\": \"sample string 1\",
              \"Value\": \"sample string 2\"
            }
          ]
        }
      ]
    }
  }
}"
NameType Required Description
name String Yes

The recipient's name.

description String No

The recipient's description.

phone String No

Phone number in format +XXXXXXXXX..., where X is a digit (from 2 to 17 digits). A comma-separated list of such phone numbers is also supported.

phone_description String No

The phone description.

email String No

The recipient's email.

email_description String No

The recipient's email description.

service_name Array No

WebHook service name (OpsGenie, Custom, Slack, ServiceNow, Splunk)

slack_configuration Object No

No documentation available.

slack_url String No

Endpoint Params path including the customer-specific service path. Example: T15676QR7/B9035RN9D/w57fxRXTE4KWcuGM2eXs6mD1

slack_channel String No

Target user or team to get the alerts

alert_title String No

Alert message title

alert_message String No

Alert message description

splunk_configuration Object No

No documentation available.

splunk_username String No

Splunk user name for login.

splunk_password String No

Splunk password for login.

splunk_host String No

The IP address for the Splunk installation.

splunk_message_type String No

The message source type.

alert_title String No

Alert message title

alert_message String No

Alert message description

service_now_configuration Object No

No documentation available.

service_now_host String No

The name of server where ServiceNow's API can be reached. Example: dev22045.service-now.com

service_now_client_id String No

The OAuth 2 client ID for the ServiceNow application

service_now_client_secret String No

The OAuth 2 client secret for the ServiceNow application

service_now_username String No

The ServiceNow instance login username

service_now_password String No

The ServiceNow instance login password

service_now_title String No

Short description of the incident

service_now_caller String No

The user ID to use as incident reporter

service_now_trigger_params Array No

Optional parameters to create a new incident.

key String No

No documentation available.

value String No

No documentation available.

service_now_resolve_params Array No

Optional parameters when resolving an incident.

key String No

No documentation available.

value String No

No documentation available.

ops_genie_configuration Object No

No documentation available.

ops_genie_host String No

The name of server where OpsGenie's API can be reached. Usally it's https://api.opsgenie.com

ops_genie_api_key String No

The API key of OpsGenie.

ops_genie_message String No

Message of the alert.

ops_genie_alias String No

Client-defined identifier of the alert, that is also the key element of alert deduplication.

ops_genie_description String No

Description field of the alert that is generally used to provide a detailed information about the alert.

ops_genie_team Object No

Teams that the alert will be routed to send notifications. If the API Key belongs to a team integration, this field will be overwritten with the owner team.

id_type String No

No documentation available.

name String No

No documentation available.

type String No

No documentation available.

key String No

No documentation available.

ops_genie_visible_to Object No

Teams and users that the alert will become visible to without sending any notification.

id_type String No

No documentation available.

name String No

No documentation available.

type String No

No documentation available.

key String No

No documentation available.

ops_genie_actions Object No

Custom actions that will be available for the alert.

id_type String No

No documentation available.

name String No

No documentation available.

type String No

No documentation available.

key String No

No documentation available.

ops_genie_tags Object No

Tags of the alert.

id_type String No

No documentation available.

name String No

No documentation available.

type String No

No documentation available.

key String No

No documentation available.

ops_genie_details Object No

Map of key-value pairs to use as custom properties of the alert.

id_type String No

No documentation available.

name String No

No documentation available.

type String No

No documentation available.

key String No

No documentation available.

ops_genie_entity String No

Entity field of the alert that is generally used to specify which domain alert is related to.

ops_genie_source String No

Source field of the alert. Default value is IP address of the incoming request.

ops_genie_priority String No

Priority level of the alert. Possible values are P1, P2, P3, P4 and P5. Default value is P3.

ops_genie_user String No

Display name of the request owner.

ops_genie_note String No

Additional note that will be added while creating the alert.

custom_configuration Object No

No documentation available.

custom_service_name String No

Name of the service to send alerts to.

custom_authentication_params Object No

No documentation available.

custom_authentication_method String No

HTTP method to use for calling the authentication server.

custom_authentication_client_id String No

Client identifier for OAuth2 authentication.

custom_authentication_client_secret String No

Application/client password for OAuth2 authentication.

custom_authentication_username String No

The user login username.

custom_authentication_password String No

The user login password.

custom_authentication_access_token_name String No

The parameter name to the response to an Access Token (A) request.Example: / access_token

custom_authentication_refresh_token_name String No

The parameter name to the response to a Refresh Token (F) request.Example: / refresh_token

custom_endpoint_params Object No

No documentation available.

custom_authentication_url String No

URL for the authentication server.

custom_authentication_method String No

Authentication method to use for the service.["None", "Basic", "OAuth2"]

custom_response_params Object No

No documentation available.

custom_response_id Integer No

id

custom_response_parameter_xpath String No

Response Parameter Xpath

custom_response_placeholder String No

placeholder

custom_response_expiring Boolean No

expiring

custom_response_parameter_definitions Object No

No documentation available.

custom_parameter_definition_id Integer No

No documentation available.

custom_parameter_definition_is_trigger Boolean No

No documentation available.

custom_parameter_definition_is_resolve Boolean No

No documentation available.

custom_parameter_definition_is_access_token Boolean No

No documentation available.

custom_parameter_definition_is_refresh_token Boolean No

No documentation available.

custom_parameter_definition_is_intermediate Boolean No

No documentation available.

custom_parameter_definition_name String No

No documentation available.

custom_parameter_definition_value String No

No documentation available.

custom_parameter_definition_placeholder String No

No documentation available.

custom_response_trigger_payload_params Object No

No documentation available.

custom_payload_param_id Integer No

No documentation available.

custom_payload_param_content_type String No

No documentation available.

custom_payload_param_data String No

No documentation available.

custom_payload_param_severities String No

No documentation available.

custom_response_resolve_payload_param Object No

No documentation available.

custom_payload_param_id Integer No

No documentation available.

custom_payload_param_content_type String No

No documentation available.

custom_payload_param_data String No

No documentation available.

custom_payload_param_severities String No

No documentation available.

custom_trigger_url String No

URL.

custom_trigger_method String No

Method - ["POST","GET","PUT","DELETE","PATCH"]

custom_resolve_url String No

URL.

custom_resolve_method String No

Method - ["POST","GET","PUT","DELETE","PATCH"]

custom_trigger_sub_requests Object No

No documentation available.

custom_sub_request_url String No

URL

custom_sub_request_method String No

Method - ["POST","GET","PUT","DELETE","PATCH"]

custom_sub_request_repeat Boolean No

No documentation available.

custom_sub_request_condition String No

No documentation available.

custom_sub_request_headers Object No

No documentation available.

custom_sub_request_headers String No

name

custom_sub_request_headers String No

value

custom_resolve_sub_requests Object No

No documentation available.

custom_sub_request_url String No

URL

custom_sub_request_method String No

Method - ["POST","GET","PUT","DELETE","PATCH"]

custom_sub_request_repeat Boolean No

No documentation available.

custom_sub_request_condition String No

No documentation available.

custom_sub_request_headers Object No

No documentation available.

custom_sub_request_headers String No

name

custom_sub_request_headers String No

value