POST
/
notifications
/
policies
/
{id}
/
recipients

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version
enum<string>

Use this header to select an API version

Available options:
2024-07-30

Path Parameters

id
string
required

Notification policy ID

Body

application/json
recipients
string[]
required

The webhook URLs or email addresses to add to the policy, depending on its channel

Response

200 - application/json
id
string
required

Unique ID

createdAt
string
required

Created at

sequenceAccountId
string
required

Sequence Account which this policy matches

name
string
required

Human-readable name

notificationTypes
enum<string>[]

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

Available options:
CUSTOMER_CREATED,
CUSTOMER_UPDATED,
CUSTOMER_ARCHIVED,
INVOICE_CREATED,
INVOICE_ISSUED,
INVOICE_UPDATED,
INTEGRATION_SYNC_COMPLETED,
INTEGRATION_WEBHOOK_HANDLED,
MERCHANT_UPDATED,
BILLING_SCHEDULE_CREATED,
BILLING_SCHEDULE_UPDATED,
BILLING_SCHEDULE_ARCHIVED,
CREDIT_NOTE_CREATED,
CREDIT_NOTE_UPDATED,
CREDIT_NOTE_ISSUED,
QUOTE_PUBLISHED,
QUOTE_ACCEPTED
recipients
string[]
required

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

channel
enum<string>
required

Notification channel

Available options:
WEBHOOK,
EMAIL
webhookSecret
string

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.

Remove a notification type from a policyRemove a recipient from a policy