Run notification delivery

POST

/api/admin/notifications/delivery/run

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/notifications/delivery/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "limit": 25 }'

Process pending or failed notification events up to the requested limit using matching enabled routes.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Run notification delivery for a limited number of pending or failed events.

Media type application/json

object

limit

integer format: int64

>= 1 <= 50

Example

{
  "limit": 25
}

Responses

200

Notification action result.

Media type application/json

object

result

required

object

key

additional properties

audit_id

One of:

string

string

null

null

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

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