Messaging and Communication Connection Profiles

The following topics describe the connection profile parameters for messaging and communication platforms and services.

Communication Suite Connection Profile Parameters

Before you can define a job, you must create a connection profile in the Configuration domain. A connection profile contains authorization credentials—such as the username, password, and other plug-in-specific parameters—and enables you to connect to the application server with only the connection profile name. To create a connection profile, see Creating a Centralized Connection Profile.

For more information about this plug-in, see Control-M Communication Suite.

The following table describes the Communication Suite connection profile parameters.

Parameter

Description

Microsoft Teams Webhook URL

Defines an incoming webhook, which enables Control-M to communicate over Microsoft Teams channels.

You must create this webhook in Teams, as described in Creating Incoming Webhooks, before you can add it to the connection profile.

https://x3dmj.webhook.office.com/webhookb2/5db2b288-138d-428d-ade7-478f727d93f3@edc0deae-5fde-4a7f-ac1e-91cb80a6526e/IncomingWebhook/ba207b318894421d9ede7c9ad1251141/05f0a54e-cec1-4df4-893b-8e61d684516a

Slack Webhook URL

Defines an incoming webhook, which enables Control-M to communicate over Slack channels.

You must create this webhook in Slack, as described in Sending Messages Using Incoming Webhooks, before you can add it to the connection profile.

httpsf2://hooks.slack.com/services/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

Telegram URL

Determines the authentication endpoint for Telegram, which enables Control-M to connect to a Telegram bot.

Default: https://api.telegram.org/bot

Telegram Bot Token

Defines a password that is used to authenticate Control-M, which enables you to access and communicate with a Telegram bot.

You must create this bot in Telegram, as described in Creating a Bot, before you can add it to the connection profile.

Telegram Chat ID

Defines a unique identifier that is assigned to a specific chat conversation in Telegram, which enables you to communicate through a bot in this chat conversation.

207397578157

WhatsApp URL

Determines the authentication endpoint for WhatsApp, which enables Control-M to connect to WhatsApp.

Format: https://graph.facebook.com/<Version>/<PhoneNumberId>/messages

WhatsApp Business ID

Defines the unique ID that is associated with your WhatsApp business account.

This enables Control-M to communicate over WhatsApp with customers who are connected to this account.

You must create a WhatsApp business account, as described in Get Started with Cloud API, before you can add it to the connection profile.

142913904062636

Phone Number ID

Defines a unique ID that is associated with the WhatsApp user.

790951673835859

Recipient Phone Number

Defines the country code and phone number of the WhatsApp user.

17185551212

User Access Token

Defines a password that is used to authenticate Control-M, which enables you to access your WhatsApp Business API and perform actions with this account.

Version

Defines the WhatsApp API version number.

Default: v15.0

Use External Vault

Determines whether to retrieve secret parameter values from an external vault, as described in CyberArk Secret Parameters in Connection Profiles.Determines whether to retrieve secret parameter values from an external vault as described in CyberArk Secret Parameters or HashiCorp Secret Parameters.

Connection Timeout

Determines the number of seconds to wait after Control-M initiates a connection request before a timeout occurs.

Default: 30

Datadog Connection Profile Parameters

Before you can define a job, you must create a connection profile in the Configuration domain. Connection profiles contain authorization credentials (such as the usernames, passwords, and other plug-in-specific parameters) and enable you to connect to the application server with only the connection profile name. To create a centralized connection profile, see Creating a Centralized Connection Profile.

For more information about this plug-in, see Control-M for Datadog.

The following table describes the Datadog connection profile parameters.

Parameter

Description

Datadog URL

Defines the base API URL for the selected site.

https://api.us3.datadoghq.com

API Key

Defines the organization-level key to authenticate API requests.

Application Key

Defines the user-level key that grants access to create, modify, or delete resources.

Use External Vault

Determines whether to retrieve secret parameter values from an external vault, as described in CyberArk Secret Parameters in Connection Profiles.Determines whether to retrieve secret parameter values from an external vault as described in CyberArk Secret Parameters or HashiCorp Secret Parameters.

HTTP Codes

Defines the HTTP codes that trigger a rerun of a job step if detected in the response.

Multiple HTTP codes must be separated with a space.

You cannot rerun a step with HTTP codes when you perform manual execution, such as rerun from point of failure.

Default: 429 404

Rerun Interval

Determines the number of seconds to wait before Control-M reruns the job step.

Default: 10

Attempts Rerun

Determines the number of attempts to rerun a job step.

Default: 3

Connection Timeout

Determines the number of seconds to wait after Control-M initiates a connection request before a timeout occurs.

Default: 60

PagerDuty Connection Profile Parameters

Before you can define a job, you must create a connection profile in the Configuration domain. A connection profile contains authorization credentials—such as the username, password, and other plug-in-specific parameters—and enables you to connect to the application server with only the connection profile name. To create a connection profile, see Creating a Centralized Connection Profile.

For more information about this plug-in, see Control-M for PagerDuty.

The following table describes the PagerDuty connection profile parameters.

Parameter

Description

PagerDuty URL

Defines the following URL for the PageDuty API:

https://api.pagerduty.com

API Key

Defines the API key to generate in PagerDuty for the API authentication.

Use External Vault

Determines whether to retrieve secret parameter values from an external vault, as described in CyberArk Secret Parameters in Connection Profiles.Determines whether to retrieve secret parameter values from an external vault as described in CyberArk Secret Parameters or HashiCorp Secret Parameters.

Connection Timeout

Determines the number of seconds to wait after Control-M initiates a connection request before a timeout occurs.

Default: 50