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 .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.

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

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	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
	]
}