BokaMera.API.Host

ListWebhookMessageAttempts

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

The following routes are available for this service:
GET	/webhook/messages/{MessageId}/attempts	List webhook message attempts

"use strict";
export class WebhookMessageAttempt {
    /** @param {{Id?:string,MessageId?:string,EndpointId?:string,Url?:string,Status?:string,ResponseStatusCode?:number,Timestamp?:string,TriggerType?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    MessageId;
    /** @type {string} */
    EndpointId;
    /** @type {string} */
    Url;
    /** @type {string} */
    Status;
    /** @type {?number} */
    ResponseStatusCode;
    /** @type {string} */
    Timestamp;
    /** @type {string} */
    TriggerType;
}
export class ListMessageAttemptsResponse {
    /** @param {{Attempts?:WebhookMessageAttempt[],Done?:boolean,Iterator?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {WebhookMessageAttempt[]} */
    Attempts = [];
    /** @type {boolean} */
    Done;
    /** @type {?string} */
    Iterator;
}
export class ListWebhookMessageAttempts {
    /** @param {{CompanyId?:string,MessageId?:string,Iterator?:string,Limit?:number,Status?:number,EventTypes?:string[],EndpointId?:string,Before?:string,After?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {string}
     * @description The ID of the webhook message. */
    MessageId;
    /**
     * @type {?string}
     * @description Pagination iterator. */
    Iterator;
    /**
     * @type {?number}
     * @description Maximum number of attempts to return. */
    Limit;
    /**
     * @type {?number}
     * @description Filter by message status. 0 = Success, 1 = Pending, 2 = Fail, 3 = Sending. */
    Status;
    /**
     * @type {?string[]}
     * @description Filter by event types. */
    EventTypes;
    /**
     * @type {?string}
     * @description Filter by endpoint ID. */
    EndpointId;
    /**
     * @type {?string}
     * @description Filter attempts before this date. */
    Before;
    /**
     * @type {?string}
     * @description Filter attempts after this date. */
    After;
}

JavaScript ListWebhookMessageAttempts DTOs

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>