Notifiers

Returns notifier destinations visible to the caller, ordered by creation time with the newest notifier first.

get/v2/notifiers

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v2/notifiers
  • Auth
    HTTP bearer

Query parameters

limitinteger

Optional. Number of notifiers to return. Defaults to 25 and must be between 1 and 200.

starting_afterstring

Cursor for forward pagination. Set to the _id of the last item from the previous page.

ending_beforestring

Cursor for backward pagination. Set to the _id of the first item from the previous page.

project_idstring

Restrict results to one project. Must be a project the caller is authorized for.

searchstring

Optional. Case-insensitive substring match on the notifier name.

typeNotifierType[]

Optional. Restrict results to these notifier types.

[
  "NOTIFIER_TYPE_SLACK_WEBHOOK"
]

Response

OK

objectstring required

Object discriminator for list responses; always list.

has_moreboolean required

Whether more notifiers are available in the selected pagination direction.

Example response

{
  "data": [
    {
      "type": "NOTIFIER_TYPE_SLACK_WEBHOOK"
    }
  ]
}

Changes

    • breaking

      removed the enum value NOTIFIER_TYPE_UNSPECIFIED from the property items/ of the query request parameter type

    • info

      added the non-success response with the status

    • info

      removed the NOTIFIER_TYPE_UNSPECIFIED enum value from the // response property for the response status

    • warning

      added the new NOTIFIER_TYPE_UNSPECIFIED enum value to the // response property for the response status

    • info

      added the enum value NOTIFIER_TYPE_UNSPECIFIED to the property items/ of the query request parameter type

    • info

      removed the non-success response with the status