Skip to content
Updawg

`POST /v1/orgs/{org}/notification-channels/{channel_id}/test`.

POST
/v1/orgs/{org}/notification-channels/{channel_id}/test
curl --request POST \
  --url https://api.updawg.net/v1/orgs/example/notification-channels/example/test

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org
required
string

Organization slug.

channel_id
required
string

The nch_… id.

Responses

Section titled “Responses”

200

Section titled “200”

Tried, and whether it arrived. Recorded in the channel’s delivery log either way.

Media typeapplication/json

How a test send went. A channel that did not accept the message is an answer, not an error: the request to try worked.

object
delivered
required
boolean
error

Why not, in the other side’s words where there were any. Never the destination.

string | null
Examplegenerated
{
  "delivered": true,
  "error": "example"
}

401

Section titled “401”

No session.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

403

Section titled “403”

Not permitted for this role.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

Section titled “404”

No such channel here.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

429

Section titled “429”

Over the organization’s request limit. Retry-After says when to try again; RateLimit-Limit is the burst.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

503

Section titled “503”

This deployment cannot decrypt channel credentials.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}