Send a test delivery now

POST

/webhooks/{id}/test

curl --request POST \
  --url https://app.whatsetter.com/api/v1/webhooks/example/test \
  --header 'Authorization: Bearer <token>'

• Production

Immediately delivers a signed sample event (is_test: true) to the subscription’s endpoint and reports its HTTP response. Integrate without waiting for a real event.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

Responses

200

Delivery attempt result

Media typeapplication/json

object

data

object

delivered

boolean

endpoint_status

integer | null

error

string | null

event_id

string

Example^generated

{
  "data": {
    "delivered": true,
    "endpoint_status": 1,
    "error": "example",
    "event_id": "example"
  }
}

401

Missing, unknown or revoked API key

Media typeapplication/json

object

error

object

code

string

message

string

Example^generated

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

404

Resource not found in this workspace

Media typeapplication/json

object

error

object

code

string

message

string

Example^generated

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