Webhooks

Retrieves the webhook and its associated subscriptions.

get
Authorizations
AuthorizationstringRequired

Enter JWT Bearer token only

Responses
200

Webhook and subscriptions retrieved successfully

get
/webhook
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"
      }
    }
  ]
}

Creates or updates the webhook.

put
Authorizations
AuthorizationstringRequired

Enter JWT Bearer token only

Body
targetUrlstring · min: 1Required

The POST URL on the partner’s system that will receive webhook payloads.

Responses
200

Webhook updated successfully

put
/webhook
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"
}

Creates a webhook subscription.

post
Authorizations
AuthorizationstringRequired

Enter JWT Bearer token only

Body

Request payload to create a new webhook subscription linking an object type and an event type.

Responses
200

Webhook subscription created successfully

post
/webhook/subscriptions
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"
}

Deletes webhook subscription.

delete
Authorizations
AuthorizationstringRequired

Enter JWT Bearer token only

Path parameters
subscriptionIdstring · uuidRequired

The unique identifier of the webhook subscription to be deleted.

Responses
200

Webhook subscription deleted successfully

delete
/webhook/subscriptions/{subscriptionId}
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