WebhookDocument

This is the representation of the WebhookDocument data structure which you receive in the Webhook API response.

{
    "id": "9ffea851-3d79-4ae9-bb3a-3ffd782e66f8",
    "appId": "6840f36d-a78f-413f-b184-16f970170f94",
    "integrationId": "6840f36d-a78f-413f-b184-16f970170f94:5c05bfe9-d429-4c43-b9d7-f1b92393d7bb:integration",
    "url": "string",
    "allEvents": true,
    "disabled": false,
    "createdAt": "2019-11-27T06:16:36+00:00",
    "updatedAt": "2019-12-03T13:32:22+00:00"
}

Property

Type

Required

Description

id

string

Y

ID of the webhook in Goki

appId

string

Y

Third-party app ID in Goki

integrationId

string

Y

ID of property's integration with Goki

url

string

Y

Your webhook URL

allEvents

boolean

Y

Indicates if the webhook is subscribed to all events

disabled

boolean

N

Indicates if the webhook is disabled or not

createdAt

string

Y

Webhook creation date

updatedAt

string

Y

Webhook modification date

Last updated