BokaMera.API.Host

<back to all web services

GetWebhookEndpoint

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
GET/webhook/endpoints/{Id}Get endpoint
GetWebhookEndpoint Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?YesThe company id, if empty will use the company id for the user you are logged in with.
IdpathstringYesThe ID of the webhook endpoint.
IncludeSecretqueryboolNoInclude Endpoint secret in the response. Default is false.
WebhookEndpoint Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
UrlformstringNo
IdformstringNo
DisabledformboolNo
EventTypesformList<string>No
SecretformstringNo

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.

GET /webhook/endpoints/{Id} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Description":"String","Url":"String","Id":"String","Disabled":false,"EventTypes":["String"],"Secret":"String"}