BokaMera.API.Host

<back to all web services

ListWebhookMessageAttempts

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
GET/webhook/messages/{MessageId}/attemptsList webhook message attempts
ListWebhookMessageAttempts Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?YesThe company id, if empty will use the company id for the user you are logged in with.
MessageIdpathstringYesThe ID of the webhook message.
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.
EndpointIdquerystringNoFilter by endpoint ID.
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 .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.

GET /webhook/messages/{MessageId}/attempts HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ListMessageAttemptsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Attempts>
    <WebhookMessageAttempt>
      <EndpointId>String</EndpointId>
      <Id>String</Id>
      <MessageId>String</MessageId>
      <ResponseStatusCode>0</ResponseStatusCode>
      <Status>String</Status>
      <Timestamp>0001-01-01T00:00:00</Timestamp>
      <TriggerType>String</TriggerType>
      <Url>String</Url>
    </WebhookMessageAttempt>
  </Attempts>
  <Done>false</Done>
  <Iterator>String</Iterator>
</ListMessageAttemptsResponse>