Send a test event to a webhook

POST

/api/v1/webhooks/test/{id}

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

Synchronously POSTs a signed webhook.test event (10 s timeout, redirects not followed) and reports the outcome; nothing is recorded as a delivery.

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Path Parameters

id

required

string

Responses

200

The test outcome

Media typeapplication/json

object

success

required

boolean

status_code

required

number | null

error

required

string | null

Example^generated

{
  "success": true,
  "status_code": 1,
  "error": "example"
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

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

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

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

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

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