Subscribe Webhook Event

Description: Subscribe webhook event

Path: /api/v1/setting/subscribeWebhookEvent

Method: POST

Request

Attributes

* = required

enabled*

boolean

Determines whether webhook are turned on.

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.

Example

{
    "enabled": true,
    "subscriptionList": [
        {
            "url": "https://go2joy-partner-service-staging.go2joy.io",
            "eventType": "booking.status_changed"
        }
    ]
}

Response

Attributes

acknowledged

boolean

The update has been applied yet

Example

{
    "code": 1,
    "message": "All went well, and (usually) some data was returned",
    "error": null,
    "data": {
        "acknowledged": true
    },
    "timestamp": 1755535780
}