Trigger a test webhook

Triggers a test webhook.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Test webhook resource.

method
required
string

HTTP request method.

Enum: "GET" "POST" "PUT" "PATCH" "DELETE"
url
required
string <uri>

URL of the webhook endpoint.

object

URI query parameters.

property name*
additional property
string

Name of additional property.

body
string

Body of the request.

credentialHash
string

Webhook credential identifier string.

Array of objects (WebhookHeader)

HTTP request headers.

Array
name
required
string

Name of the property.

value
required
string

Value of the property.

status
string (OnOff)
Default: "active"
Enum: "active" "inactive"
Responses
200

Test webhook triggered.

Response Schema: application/json
method
required
string

HTTP request method.

Enum: "GET" "POST" "PUT" "PATCH" "DELETE"
url
required
string <uri>

URL of the webhook endpoint.

object

URI query parameters.

property name*
additional property
string

Name of additional property.

body
string

Body of the request.

credentialHash
string

Webhook credential identifier string.

Array of objects (WebhookHeader)

HTTP request headers.

Array
name
required
string

Name of the property.

value
required
string

Value of the property.

status
string (OnOff)
Default: "active"
Enum: "active" "inactive"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

post/previews/rule-actions/trigger-webhook
Request samples
application/json
{
  • "method": "GET",
  • "query": {
    },
  • "body": "string",
  • "credentialHash": "string",
  • "headers": [
    ]
}
Response samples
application/json
{
  • "method": "GET",
  • "query": {
    },
  • "body": "string",
  • "credentialHash": "string",
  • "headers": [
    ]
}