| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /webhook/endpoints/{Id}/test | Test 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 .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<TestWebhookEndpoint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Id>String</Id>
</TestWebhookEndpoint>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <TestWebhookEndpointResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos"> <MessageId>String</MessageId> </TestWebhookEndpointResponse>