Notification Policies

List All Notification Policies

Changed on

List All Notification Policies

get/notifications/policies

Request

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

Query parameters

notificationType'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' | 'QUOTE_SIGNED' | 'INVOICE_REMINDER_SENT' | 'WATCHTOWER_TASK_ASSIGNED'

Filter policies by notification type

limitinteger

Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).

afterstring

Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.

beforestring

Pagination offset. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.next or pagination.previous to retrieve each page.

Headers

Authorizationstring required

Your API credentials. Eg. Basic {credentials}.

sequence-version'2024-07-30'

Use this header to select an API version

Response

OK

Example response

{
  "items": [
    {
      "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"
      ],
      "channel": "EMAIL"
    }
  ],
  "pagination": {
    "after": "ZTMwOWU5NDgtMDg4ZS00ZDc3LWI2NTQtY2Q4NTQ5OGYxNTU1IzE2NTgyNjA4NTYwMzMwMTMjREVTQw==",
    "before": "NjRlZjJmZjktMmJjYi00M2RiLWI0ZDUtOTAxMDU4MjRiMTdmIzE2NTgyNjA3NTk3NTE2ODEjQVND",
    "totalResultSize": 100
  }
}

Changes

  • 89ff54cddea4Revision changes
    • breaking

      for the query request parameter limit, the format changed from no format to int32

    • warning

      deleted the header request parameter Sequence-Version

    • info

      added the new optional header request parameter sequence-version

  • e6edbedb3486Revision changes
    • info

      added the new optional query request parameter notificationType

    • info

      added the non-success response with the status