events_transports_create

POST 
/api/v3//events/transports/

NotificationTransport Viewset

Request

application/json

Body

required

name stringrequired

Possible values: non-empty

mode NotificationTransportModeEnum (string)

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

webhook_url uri
webhook_mapping uuidnullable
send_once boolean

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

Responses

201

application/json

Schema

Schema

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.

Example (from schema)

{
  "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
}

400

application/json

Schema

Schema

non_field_errors string[]
code string
property name* any

Validation Error

Example (from schema)

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

403

application/json

Schema

Schema

detail stringrequired
code string

Example (from schema)

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L '/api/v3/events/transports/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "name": "string",
  "mode": "local",
  "webhook_url": "string",
  "webhook_mapping": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "send_once": true
}'

Request Collapse all

Base URL

/api/v3

Auth

Bearer Token

Body required

{
  "name": "string",
  "mode": "local",
  "webhook_url": "string",
  "webhook_mapping": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "send_once": true
}