BokaMera.API.Host

<back to all web services

UpdateWebhookSettingsRequest

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/webhook/settingsEnable or disable webhook feature for the companySets the webhook feature flag for the company identified by the API key in the header
"use strict";
export class WebhookSettingsResponse {
    /** @param {{Enabled?:boolean,Message?:string,CompanyId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Enabled;
    /** @type {string} */
    Message;
    /** @type {string} */
    CompanyId;
}
export class UpdateWebhookSettingsRequest {
    /** @param {{CompanyId?:string,Enabled?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /** @type {boolean} */
    Enabled;
}

JavaScript UpdateWebhookSettingsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /webhook/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	Enabled: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Enabled: False,
	Message: String
}