Webhooks
Enter JWT Bearer token only
Webhook and subscriptions retrieved successfully
Invalid request
The client application is not authorized to access this resource
Webhook not found
An unexpected error occurred
GET /homedashboard/webhook HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"targetUrl": "text",
"createdTimestamp": "2025-12-06T04:35:22.020Z",
"updatedTimestamp": "2025-12-06T04:35:22.020Z",
"subscriptions": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"updatedTimestamp": "2025-12-06T04:35:22.020Z",
"createdTimestamp": "2025-12-06T04:35:22.020Z",
"objectType": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
},
"eventType": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "text"
}
}
]
}Enter JWT Bearer token only
The POST URL on the partner’s system that will receive webhook payloads.
Webhook updated successfully
Invalid request payload
The client application is not authorized to perform this action
An unexpected error occurred
PUT /homedashboard/webhook HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json;odata.metadata=minimal;odata.streaming=true
Accept: */*
Content-Length: 20
{
"targetUrl": "text"
}{
"id": "text",
"type": "text",
"createdTimestamp": "2025-12-06T04:35:22.020Z",
"updatedTimestamp": "2025-12-06T04:35:22.020Z"
}Enter JWT Bearer token only
Request payload to create a new webhook subscription linking an object type and an event type.
Webhook subscription created successfully
Invalid request payload
The client application is not authorized to perform this action
Webhook not found
An unexpected error occurred
POST /homedashboard/webhook/subscriptions HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json;odata.metadata=minimal;odata.streaming=true
Accept: */*
Content-Length: 118
{
"objectType": {
"id": "123e4567-e89b-12d3-a456-426614174000"
},
"eventType": {
"id": "123e4567-e89b-12d3-a456-426614174000"
}
}{
"id": "text",
"type": "text",
"createdTimestamp": "2025-12-06T04:35:22.020Z",
"updatedTimestamp": "2025-12-06T04:35:22.020Z"
}Enter JWT Bearer token only
The unique identifier of the webhook subscription to be deleted.
Webhook subscription deleted successfully
Invalid request payload
The client application is not authorized to perform this action
Webhook or subscription not found
An unexpected error occurred
DELETE /homedashboard/webhook/subscriptions/{subscriptionId} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "text",
"type": "text",
"createdTimestamp": "2025-12-06T04:35:22.020Z",
"updatedTimestamp": "2025-12-06T04:35:22.020Z"
}Last updated

