Notification Policies

Create Notification policy

Changed on

Create a new Notification Policy, which will send matching notifications to the recipients you specify.

post/notifications/policies

Request

  • Base URL
    https://sandbox.sequencehq.com/api
  • URL
    https://sandbox.sequencehq.com/api/notifications/policies
  • Auth
    none declared. Required headers: Authorization

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Request body

namestring required

Human-readable name

notificationTypesNotificationType[]

Set of notification types that this policy matches. If not provided, then this policy will apply to all notification types.

recipientsstring[] required

The webhook URLs or email addresses which will receive notifications, depending on the channel

channel'WEBHOOK' | 'EMAIL' required
webhookSecretstring

Webhook secret used to generate a signature header that's sent with an outbound webhook.It can be used to verify the authenticity of received Sequence webhooks. Only available for webhook channel policies.

Example request

{
  "name": "Dev team integration webhooks",
  "notificationTypes": [
    "CUSTOMER_CREATED"
  ],
  "recipients": [
    "https://api.company.com/webhooks"
  ],
  "channel": "WEBHOOK",
  "webhookSecret": "whsec_UserSubmittedSecret1234567890abc"
}

Response

Created

idstring required

Unique ID

createdAtstring required

Created at

sequenceAccountIdstring required

Sequence Account which this policy matches

namestring required

Human-readable name

notificationTypesNotificationType[]

Set of notification types that this policy matches. If not present this policy will cover all notification types.

recipientsstring[] required

The webhook URLs or email addresses which will receive notifications, depending on the channel

channel'WEBHOOK' | 'EMAIL' required
webhookSecretstring

Webhook secret used to generate a signature header that's sent with an outbound webhook.It can be used to verify the authenticity of received Sequence webhooks. Only available for webhook channel policies.

Example response

{
  "id": "9c4c54e7-59da-44ae-9cc5-7fd81be7c133",
  "createdAt": "2022-06-28T16:47:00Z",
  "sequenceAccountId": "c4602d51-0fb4-4b48-b689-6ba28f540d1e",
  "name": "Finance team emails",
  "notificationTypes": [
    "CUSTOMER_CREATED"
  ],
  "recipients": [
    "finance@example.com",
    "operations@example.com"
  ],
  "channel": "EMAIL"
}

Changes

  • 89ff54cddea4Revision changes
    • warning

      deleted the header request parameter Sequence-Version

    • info

      added the new optional header request parameter sequence-version

  • e5abd262244eRevision changes
    • warning

      added the new WATCHTOWER_TASK_ASSIGNED enum value to the / response property for the response status

    • info

      added the new WATCHTOWER_TASK_ASSIGNED enum value to the request property /