Send a test delivery

POST

/api/v1/organizations/{orgID}/webhooks/{webhookID}/test

curl --request POST \
  --url https://api.aetherplatform.cloud/api/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/webhooks/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/test \
  --header 'Authorization: Bearer <token>'

Enqueues a signed ping event to this webhook. It is delivered asynchronously by the same worker as real events — proving the full delivery path, not just reachability. Check the deliveries listing for the outcome.

Authorizations

• bearerApiToken

Parameters

Path Parameters

orgID

required

string format: uuid

Organization UUID.

webhookID

required

string format: uuid

Webhook UUID.

Responses

202

Test delivery enqueued.

Media typeapplication/json

object

status

A short status word, e.g. “deleting”, “deleted”, or “ok”.

string

Example^generated

{
  "status": "example"
}

401

Missing or invalid credentials.

Media typeapplication/json

object

error

required

object

code

required

A stable, machine-readable error code.

string

message

required

string

details

Array<object>

object

field

required

string

code

required

string

message

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": [
      {
        "field": "example",
        "code": "example",
        "message": "example"
      }
    ]
  }
}

404

The requested resource was not found.

Media typeapplication/json

object

error

required

object

code

required

A stable, machine-readable error code.

string

message

required

string

details

Array<object>

object

field

required

string

code

required

string

message

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": [
      {
        "field": "example",
        "code": "example",
        "message": "example"
      }
    ]
  }
}

409

The webhook is disabled (webhook_disabled) — enable it first.

Media typeapplication/json

object

error

required

object

code

required

A stable, machine-readable error code.

string

message

required

string

details

Array<object>

object

field

required

string

code

required

string

message

required

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": [
      {
        "field": "example",
        "code": "example",
        "message": "example"
      }
    ]
  }
}