Action Webhook
This method executes specified action on a given webhook.
Request
URI
POST
https://{api_host}/api/notification/{orgId}/webhooks/{webhook}
COPY
Path Parameters
string
orgId
Required
Org ID
string
webhook
Required
Webhook identifier
Query Parameters
string
action
Required
Actions
simulate-event: Test webhook by simulating event.
Possible values are :
simulate_event,
dummy,
Responses
200
OK
Returns
WebhookTestResponse
of type(s)
application/json
{
"error": "string",
"payload": {},
"status": "string"
}
string
error
Optional
Error details with more information.
object
payload
Optional
Webhook payload sent to customer callback url.
string
status
Optional
status
400
Bad Request
Returns
ErrorResponse
of type(s)
application/json
"ErrorResponse Object"
object
messages
Optional
Message of Error
string
type
Optional
type
401
Unauthorized
Returns
WebhookTestResponse
of type(s)
application/json
"WebhookTestResponse Object"
string
error
Optional
Error details with more information.
object
payload
Optional
Webhook payload sent to customer callback url.
string
status
Optional
status
403
Forbidden
Returns
WebhookTestResponse
of type(s)
application/json
"WebhookTestResponse Object"
string
error
Optional
Error details with more information.
object
payload
Optional
Webhook payload sent to customer callback url.
string
status
Optional
status
404
Not Found
Returns
ErrorResponse
of type(s)
application/json
"ErrorResponse Object"
object
messages
Optional
Message of Error
string
type
Optional
type
500
Internal Server Error
Returns
ErrorResponse
of type(s)
application/json
"ErrorResponse Object"
object
messages
Optional
Message of Error
string
type
Optional
type
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' https://{api_host}/api/notification/{orgId}/webhooks/{webhook}