BokaMera.API.Host

<back to all web services

CreateWebhookEndpoint

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/webhook/endpointsCreate webhook endpoint
CreateWebhookEndpoint Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?YesThe company id, if empty will use the company id for the user you are logged in with.
UrlbodyUriYesThe webhook endpoint URL.
EventTypesbodyList<string>YesList of event types. At least one event type is required.
DescriptionbodystringNo
DisabledbodyboolNo
WebhookEndpoint Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
UrlformstringNo
IdformstringNo
DisabledformboolNo
EventTypesformList<string>No

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

HTTP + XML

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

POST /webhook/endpoints HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateWebhookEndpoint 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>
  <Description>String</Description>
  <Disabled>false</Disabled>
  <EventTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EventTypes>
  <Url i:nil="true" />
</CreateWebhookEndpoint>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WebhookEndpoint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Description>String</Description>
  <Disabled>false</Disabled>
  <EventTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EventTypes>
  <Id>String</Id>
  <Url>String</Url>
</WebhookEndpoint>