List all Notifications Events Conditions

GET 
/notification_event_conditions

Returns a list of your notifications events conditions.

Request

Query Parameters

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load

page[size] integer

Possible values: >= 1 and <= 250

Default value: 20

The size of the page

filter[associated_record_type][eq] string

Possible values: [account, phone_number]

Filter by the associated record type

Responses

200: Returns a list of notification event conditions available.

application/json

• Schema
• Example (from schema)

Schema

data

NotificationEventCondition[]

Array [

id string

A UUID.

name string

description string

notification_event_id string

associated_record_type string

Possible values: [account, phone_number]

parameters

object[]

Array [

name string

optional boolean

data_type string

]

enabled boolean

allow_multiple_channels boolean

Dictates whether a notification channel id needs to be provided when creating a notficiation setting.

asynchronous boolean

Dictates whether a notification setting will take effect immediately.

supported_channels string[]

Dictates the supported notification channel types that can be emitted.

created_at date-time

ISO 8601 formatted date indicating when the resource was created.

updated_at date-time

ISO 8601 formatted date indicating when the resource was updated.

]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "data": [
    {
      "id": "70c7c5cb-dce2-4124-accb-870d39dbe852",
      "name": "from phone number",
      "description": "When emergency number dialed from phone number X",
      "notification_event_id": "d5c395cd-9864-4609-b5e2-3f9fd4ce201a",
      "associated_record_type": "phone_number",
      "parameters": [
        {
          "name": "phone_number",
          "optional": false,
          "data_type": "string"
        }
      ],
      "enabled": true,
      "allow_multiple_channels": false,
      "asynchronous": true,
      "supported_channels": [
        "webhook",
        "sms",
        "email",
        "voice"
      ],
      "created_at": "2019-10-15T10:07:15.527Z",
      "updated_at": "2019-10-15T10:07:15.527Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code intrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Loading...