Skip to content

Send test event to subscription

POST
/api/v1/integrations/webhooks/{subscription_id}/test
curl --request POST \
--url https://api.ultimateteam.ai/api/v1/integrations/webhooks/example/test \
--header 'X-API-Key: <X-API-Key>'

Sends a test event payload to the subscription URL and returns the delivery result.

subscription_id
required
Subscription Id
string

Successful Response

Media typeapplication/json
Response Test Webhook Subscription Api V1 Integrations Webhooks Subscription Id Test Post
object
key
additional properties
any
Examplegenerated
{}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}