BokaMera.API.Host

<back to all web services

ListWebhookEndpointAttempts

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
GET/webhook/endpoints/{EndpointId}/attemptsList webhook endpoint attempts
ListWebhookEndpointAttempts Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?YesThe company id, if empty will use the company id for the user you are logged in with.
EndpointIdpathstringYesThe ID of the webhook endpoint.
IteratorquerystringNoPagination iterator.
Limitqueryint?NoMaximum number of attempts to return.
Statusqueryint?NoFilter by message status. 0 = Success, 1 = Pending, 2 = Fail, 3 = Sending.
EventTypesqueryList<string>NoFilter by event types.
BeforequeryDateTime?NoFilter attempts before this date.
AfterqueryDateTime?NoFilter attempts after this date.
ListMessageAttemptsResponse Parameters:
NameParameterData TypeRequiredDescription
AttemptsformList<WebhookMessageAttempt>Yes
DoneformboolNo
IteratorformstringNo
WebhookMessageAttempt Parameters:
NameParameterData TypeRequiredDescription
IdformstringYes
MessageIdformstringYes
EndpointIdformstringYes
UrlformstringYes
StatusformstringYes
ResponseStatusCodeformint?No
TimestampformDateTimeNo
TriggerTypeformstringYes

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/{EndpointId}/attempts HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Attempts":[{"Id":"String","MessageId":"String","EndpointId":"String","Url":"String","Status":"String","ResponseStatusCode":0,"TriggerType":"String"}],"Done":false,"Iterator":"String"}