Test a webhook

POST 
/v1/webhooks/:id/test

test a webhook.

Request

Path Parameters

id stringrequired

application/json

Body

required

payload

object

required

property name* any

Responses

200

application/json

Schema

Schema

operation stringrequired

Operation performed

success booleanrequired

Specify whether the operation was successful

Example (from schema)

{
  "operation": "string",
  "success": true
}

400

application/json

Schema

Schema

errors

object[]

The list of API errors

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

]

Example (from schema)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "details": {}
    }
  ]
}

500

application/json

Schema

Schema

errors

object[]

The list of API errors

Array [

message string

The error or warning message

code string

The message code

details

object

any additional details

property name* any

any additional details

]

Example (from schema)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "details": {}
    }
  ]
}

Loading...