Get Webhook Setup Info

Description: Get webhook setup info

Path: /api/v1/setting/getWebhookSetupInfo

Method: GET

Response

Attributes

enabled

boolean

Determines whether webhook are turned on.

allowedEventTypeList

array

Determines whether to include a list of all supported webhook events.

subscriptionList

array

Specifies an array of events for your webhook server to subscribe to. If set to an empty array, the server unsubscribes from all events and webhooks are turned off.

subscriptionList.*.url

string

Specifies the URL of your webhook server to receive payloads for events.

subscriptionList.*.eventType

string

Event type for your webhook server to subscribe to.

{
    "code": 1,
    "message": "All went well, and (usually) some data was returned",
    "error": null,
    "data": {
        "enabled": false,
        "allowedEventTypeList": [
            "booking.created",
            "booking.status_changed"
        ],
        "subscriptionList": [
            {
                "url": "https://go2joy-partner-service-staging.go2joy.io",
                "eventType": "booking.status_changed"
            }
        ]
    },
    "timestamp": 1755533287
}