BokaMera.API.Host

<back to all web services

UpdateWebhookEndpoint

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/webhook/endpoints/{Id}Update webhook endpoint
UpdateWebhookEndpoint Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?YesThe company id, if empty will use the company id for the user you are logged in with.
UrlbodystringYesThe webhook endpoint URL.
IdpathstringYesThe ID of the webhook endpoint.
EventTypesbodyList<string>YesList of event types. At least one event type is required.
DescriptionbodystringYes
DisabledbodyboolNo
WebhookEndpoint Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYes
UrlformstringYes
IdformstringYes
DisabledformboolNo
EventTypesformList<string>Yes
SecretformstringYes

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.

PUT /webhook/endpoints/{Id} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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