List notification integrations | Integrations | Northflank API docs
v1
ApplicationAPI & CLI
Double column
API
CLI
JS Client

Integrations /

List notification integrations

Lists notification integrations for the authenticated user or team.

Required permission

Account > Team > Notifications > Read

Query parameters

    • per_page

      integer

      The number of results to display per request. Maximum of 100 results per page.

    • page

      integer

      The page number to access.

    • cursor

      string

      The cursor returned from the previous page of results, used to request the next page.

Response body

  • {object}

    Response object.

    • data

      {object} required

      Result data.

      • notificationIntegrations

        [array] required

        An array of notification integrations on the account.

        • {object}

          • name

            string required

            The name of the notification integration.

            min length
            3
            max length
            39
            pattern
            ^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$

          • id

            string required

            The ID of the notification integration.

          • type

            string required

            The provider to send webhooks to. RAW_WEBHOOK allows you to send webhooks to a url of your choice, or you can choose a specific provider.

            one of
            RAW_WEBHOOK, SLACK, DISCORD, TEAMS

          • webhook

            string required

            The URL where webhooks will be sent.

          • status

            {object}

            Information on the current webhook status.

            • disabled

              boolean

              Is the webhook currently disabled?

            • reason

              boolean

              Why the webhook was disabled.

          • createdAt

            string required

            Creation date

          • updatedAt

            string required

            Last update date

    • pagination

      {object} required

      Data about the endpoint pagination.

      • hasNextPage

        boolean required

        Is there another page of results available?

      • cursor

        string

        The cursor to access the next page of results.

      • count

        number required

        The number of results returned by this request.

API
CLI
JS Client

GET /v1/integrations/notifications

Example response

200 OK

A list of notification integrations for the authenticated user or team

JSON

{
  "data": {
    "notificationIntegrations": [
      {
        "name": "Example Notification",
        "id": "example-notification",
        "type": "RAW_WEBHOOK",
        "webhook": "https://example.com/webhooks",
        "status": {
          "disabled": false
        },
        "createdAt": "2023-09-12T16:39:44.166Z\"",
        "updatedAt": "2023-09-12T16:39:44.166Z\""
      }
    ]
  },
  "pagination": {
    "hasNextPage": false,
    "count": 1
  }
}

© 2024 Northflank Ltd. All rights reserved.

northflank.comTermsPrivacyfeedback@northflank.com