BokaMera.API.Host

<back to all web services

TestWebhookEndpoint

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/webhook/endpoints/{Id}/testTest webhook endpoint by sending a sample message
"use strict";
export class TestWebhookEndpointResponse {
    /** @param {{MessageId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    MessageId;
}
export class TestWebhookEndpoint {
    /** @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 to test. */
    Id;
}

JavaScript TestWebhookEndpoint DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /webhook/endpoints/{Id}/test HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"MessageId":"String"}