TAtalkdesk
Automated Notifications

Get rule by id

Retrieves the details of a specific automated notification rule by its unique identifier. Use this endpoint to inspect a rule's configuration, conditions, and associated actions before making updates. Only rules belonging to the authenticated account are accessible.

get/automated-notifications/rules/{rule_id}

Request

  • Base URL
    https://api.talkdeskapp.com
  • URL
    https://api.talkdeskapp.com/automated-notifications/rules/{rule_id}
  • Auth
    OAuth 2
    Authorization code: https://{account_name}.talkdeskid.com/oauth/authorize
    Token URL: https://{account_name}.talkdeskid.com/oauth/token scopes: automated-notifications-management:read

Path parameters

rule_idstring required
Example:82ba9989-f98a-4aa5-8388-d75138629a76

The id of the rule.

Response

OK

idstring required

The id of the Rule.

namestring required

The name of the Rule.

action_type'STUDIO_FLOW_TRIGGER' | 'NO_AUTH_HTTP_TRIGGER' required

The action type triggered by this Rule.

trigger_on'PRIMARY_EVENT_DATE' | 'SECONDARY_EVENT_DATE' required

The trigger type the rule should be triggered on.

discard_out_of_available_intervalboolean required

Should discard event notifications out of available interval.

include_conversation_historyboolean required

Include the conversation history in the Rule.

escalate_touchpoint_idstring

The Touchpoint id for escalation.

topic_idsstring[]
created_datestring date-time

The date when the Rule was created.

updated_datestring date-time

The date when the Rule was updated.

Changes

No recorded changes to this operation across all 2 revisions of this API.