events_transports_list

GET /events/transports/

NotificationTransport Viewset

Request

Query Parameters

mode string

Possible values: [email, local, webhook, webhook_slack]

name string

ordering string

Which field to use when ordering the results.

page integer

A page number within the paginated result set.

page_size integer

Number of results to return per page.

search string

A search term.

send_once boolean

webhook_url string

Responses

application/json

Schema
Example (from schema)

Schema

pagination

object

required

next numberrequired

previous numberrequired

count numberrequired

current numberrequired

total_pages numberrequired

start_index numberrequired

end_index numberrequired

results

object[]

required

Array [

pk uuidrequired

name stringrequired

mode NotificationTransportModeEnum (string)

Possible values: [local, webhook, webhook_slack, email]

mode_verbose stringrequired

Return selected mode with a UI Label

webhook_url uri

webhook_mapping uuidnullable

send_once boolean

Only send notification once, for example when sending a webhook into a chat channel.

]

{
  "pagination": {
    "next": 0,
    "previous": 0,
    "count": 0,
    "current": 0,
    "total_pages": 0,
    "start_index": 0,
    "end_index": 0
  },
  "results": [
    {
      "pk": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "mode": "local",
      "mode_verbose": "string",
      "webhook_url": "string",
      "webhook_mapping": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "send_once": true
    }
  ]
}

application/json

Schema
Example (from schema)

Schema

non_field_errors string[]

code string

property name* any

Validation Error

{
  "non_field_errors": [
    "string"
  ],
  "code": "string"
}

application/json

Schema
Example (from schema)

Schema

detail stringrequired

code string

{
  "detail": "string",
  "code": "string"
}

events_transports_list