BokaMera.API.Host

<back to all web services

GetWebhookEndpoint

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
GET/webhook/endpoints/{Id}Get 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 GetWebhookEndpoint {
    /** @param {{CompanyId?:string,Id?:string}} [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 ID of the webhook endpoint. */
    Id;
}

JavaScript GetWebhookEndpoint DTOs

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

HTTP + CSV

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

GET /webhook/endpoints/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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