logo

Trigger a test webhook

Triggers a test webhook.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json

Test webhook resource.

method
required
string

Method of the HTTP request.

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

URL of the webhook endpoint.

object

Query parameters of the URI.

property name*
additional property
string

Name of additional property.

body
string

Body of the request.

credentialHash
string

ID of the webhook credential.

Array of objects (WebhookHeader)

Headers of the HTTP request.

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

Method of the HTTP request.

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

URL of the webhook endpoint.

object

Query parameters of the URI.

property name*
additional property
string

Name of additional property.

body
string

Body of the request.

credentialHash
string

ID of the webhook credential.

Array of objects (WebhookHeader)

Headers of the HTTP request.

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",
  • "url": "http://example.com",
  • "query": {
    },
  • "body": "string",
  • "credentialHash": "string",
  • "headers": [
    ]
}
Response samples
application/json
{
  • "method": "GET",
  • "url": "http://example.com",
  • "query": {
    },
  • "body": "string",
  • "credentialHash": "string",
  • "headers": [
    ]
}
➔ Next to Rules timeline