Ping a webhook endpoint (creates and sends a synthetic event)

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

organizationIdstringRequired

webhookIdstringRequired

This endpoint expects an object.

datamap from strings to anyOptional

Optional additional data to include in ping payload

idstring

organizationIdstring

typestring

versionstring

occurredAtdatetime

payloadstring

Stringified JSON payload (redacted in read APIs)

createdAtdatetime

merchantIdstring or null

requestIdstring or null

1	import requests
2
3	url = "https://api-test.koywe.com/api/v1/organizations/organizationId/webhooks/webhookId/ping"
4
5	payload = {}
6	headers = {
7	"Authorization": "Bearer <token>",
8	"Content-Type": "application/json"
9	}
10
11	response = requests.post(url, json=payload, headers=headers)
12
13	print(response.json())

1	{
2	"id": "id",
3	"organizationId": "organizationId",
4	"type": "type",
5	"version": "version",
6	"occurredAt": "2024-01-15T09:30:00Z",
7	"payload": "payload",
8	"createdAt": "2024-01-15T09:30:00Z",
9	"merchantId": "merchantId",
10	"requestId": "requestId"
11	}