BokaMera.API.Host

ListWebhookEndpointAttempts

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
GET	/webhook/endpoints/{EndpointId}/attempts	List webhook endpoint attempts

**ListWebhookEndpointAttempts** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	query	Guid?	Yes	The company id, if empty will use the company id for the user you are logged in with.
EndpointId	path	string	Yes	The ID of the webhook endpoint.
Iterator	query	string	No	Pagination iterator.
Limit	query	int?	No	Maximum number of attempts to return.
Status	query	int?	No	Filter by message status. 0 = Success, 1 = Pending, 2 = Fail, 3 = Sending.
EventTypes	query	List<string>	No	Filter by event types.
Before	query	DateTime?	No	Filter attempts before this date.
After	query	DateTime?	No	Filter attempts after this date.

**ListMessageAttemptsResponse** Parameters:
Name	Parameter	Data Type	Required
Attempts	form	List<WebhookMessageAttempt>	Yes
Done	form	bool	No
Iterator	form	string	No

**WebhookMessageAttempt** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	Yes
MessageId	form	string	Yes
EndpointId	form	string	Yes
Url	form	string	Yes
Status	form	string	Yes
ResponseStatusCode	form	int?	No
Timestamp	form	DateTime	No
TriggerType	form	string	Yes

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/endpoints/{EndpointId}/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>