Test webhook
The endpoint allows you to test an existing webhook. It sends a webhook with a given identifier for a dummy connector with identifier _connector_1
Request schema
Path parameters
webhookId
stringrequired
The webhook ID
example:
Header parameters
Authorization
stringrequired
HTTP: basicAuth
HTTP AuthorizationScheme: basic
Accept
string
default:
example:
Request
event
stringrequired
Type of event that should be sent for a test.
example:
Http + 1.1
POST
https://api.fivetran.com/v1/webhooks/webhook_id/test
POST /v1/webhooks/webhook_id/test HTTP/1.1
Accept: application/json
Authorization: Basic REPLACE_BASIC_AUTH
Content-Type: application/json
Host: api.fivetran.com
Content-Length: 25
{
"event": "sync_end"
}Responses
200
Successful response
404
Webhook not found
Successful response schema
code
stringrequired
Response status code
example:
message
string
Response status text
example:
data
objectrequired
succeed
booleanrequired
Test result.
example:
status
integerrequired
Test status.
format:
example:
message
string
Test message.
example:
{
"code": "Success",
"message": "Operation performed.",
"data": {
"succeed": true,
"status": 200,
"message": "Success"
}
}