Send a test event to a webhook endpoint

POST

/v1/webhook-endpoints/{endpointId}/test

curl --request POST \
  --url https://example.com/v1/webhook-endpoints/example/test \
  --header 'Authorization: Bearer <token>'

• Same-origin — path relative to the deployment root.

Queues a webhook.test event, signed like any other, to check the receiver end to end. Follow it in the delivery log.

Authorizations

• bearerAuth

Parameters

Path Parameters

endpointId

required

string

The webhook endpoint id.

Header Parameters

Idempotency-Key

string

>= 1 characters

Caller-supplied idempotency key. Retries with the same key return the original response byte-identical (per docs/API-ROUTE-CONVENTIONS.md §3.1).

Responses

202

Queued.

Media typeapplication/json

object

deliveryId

required

string

endpointId

required

string

event

required

One of: discriminator: type

object

object

id

required

Event id, also sent as the webhook-id header; the same on every retry.

string

type

required

string

Allowed value: run.finished

createdAt

required

string format: date-time

data

required

object

run

required

A finished top-level run: its identity and outcome, never its input or output. Field names match GET /v1/runs/{runId}.

object

id

required

RunId.

string format: uuid

projectId

required

string format: uuid

flowId

required

string

flowVersion

required

string

status

required

string

Allowed values: completed failed cancelled

dryRun

required

boolean

failureMessage

required

Why the run failed or was cancelled; null when it completed.

string | null

createdAt

required

string format: date-time

completedAt

required

string format: date-time

object

object

id

required

string

type

required

string

Allowed value: webhook.test

createdAt

required

string format: date-time

data

required

object

endpointId

required

string

status

required

pending: waiting for its next attempt. delivered: the endpoint answered 2xx. failed: every attempt failed, or the endpoint was unregistered first; redeliver queues it again.

string

Allowed values: pending delivered failed

attempts

required

integer

nextAttemptAt

required

string | null format: date-time

lastAttemptAt

required

string | null format: date-time

lastResponseStatus

required

HTTP status of the last attempt; null when it got no response.

integer | null

lastError

required

Why the last attempt failed (timeout, connection-refused, url-refused, …).

string | null

createdAt

required

string format: date-time

deliveredAt

required

string | null format: date-time

Example

{
  "event": {
    "type": "run.finished",
    "data": {
      "run": {
        "status": "completed"
      }
    }
  },
  "status": "pending"
}

400

Malformed request body.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

401

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

404

No endpoint with that id.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

409

Idempotency-Key was reused with a different body, or resource-state conflict.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

500

Server error (unmapped domain code or framework crash).

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}