BokaMera.API.Host

<back to all web services

UpdateWebhookEndpoint

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/webhook/endpoints/{id}Update webhook endpoint
"use strict";
export class WebhookEndpoint {
    /** @param {{Description?:string,Url?:string,Id?:string,Disabled?:boolean,EventTypes?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Description;
    /** @type {string} */
    Url;
    /** @type {string} */
    Id;
    /** @type {boolean} */
    Disabled;
    /** @type {string[]} */
    EventTypes;
}
export class UpdateWebhookEndpoint {
    /** @param {{CompanyId?:string,Url?:string,Id?:string,EventTypes?:string[],Description?:string,Disabled?: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 {string}
     * @description The webhook endpoint URL. */
    Url;
    /**
     * @type {string}
     * @description The ID of the webhook endpoint. */
    Id;
    /**
     * @type {string[]}
     * @description List of event types. At least one event type is required. */
    EventTypes;
    /** @type {string} */
    Description;
    /** @type {boolean} */
    Disabled;
}

JavaScript UpdateWebhookEndpoint 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/endpoints/{id} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	Url: String,
	Id: String,
	EventTypes: 
	[
		String
	],
	Description: String,
	Disabled: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Description: String,
	Url: String,
	Id: String,
	Disabled: False,
	EventTypes: 
	[
		String
	]
}