Skip to main content

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.

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

default: Unexpected error

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
  • ]

Loading...