Skip to content
Authrim

Deliver a notification event

POST
/api/admin/notifications/{id}/deliver
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/notifications/example/deliver \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

Manually deliver one notification event through all matching enabled notification delivery routes.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Request Body

Section titled “Request Body ”
Media type application/json
object
key
additional properties
Example 
{}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Notification action result.

Media type application/json
object
result
required
object
key
additional properties
audit_id
One of:
string
job_id
string
key
additional properties
Example 
{
  "result": {
    "event_id": "notif_123",
    "route_count": 1,
    "results": [
      {
        "route_id": "indr_123",
        "provider": "email",
        "status": "delivered"
      }
    ]
  },
  "audit_id": "audit_123"
}

default

Section titled “default ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}