BokaMera.API.Host

<back to all web services

GetStripeWebhookEvents

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin
The following routes are available for this service:
GET/payment/stripe/v1/webhookeventReturn all possible webhook events

export class StripeWebhookResponse
{
    public Id: string;
    public Events: string[];
    public Url: string;

    public constructor(init?: Partial<StripeWebhookResponse>) { (Object as any).assign(this, init); }
}

export class StripeWebhooksResponse
{
    public StripeWebhooks: StripeWebhookResponse[];

    public constructor(init?: Partial<StripeWebhooksResponse>) { (Object as any).assign(this, init); }
}

// @ValidateRequest(Validator="IsAuthenticated")
export class GetStripeWebhookEvents implements ICompany
{
    /** @description The company id, if empty will use the company id for the user you are logged in with. */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    public CompanyId?: string;

    /** @description Webhook Id to update events */
    // @ApiMember(Description="Webhook Id to update events")
    public WebhookId: string;

    public constructor(init?: Partial<GetStripeWebhookEvents>) { (Object as any).assign(this, init); }
}

TypeScript GetStripeWebhookEvents 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 /payment/stripe/v1/webhookevent HTTP/1.1 
Host: api.bookmore.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StripeWebhooksResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <StripeWebhooks>
    <StripeWebhookResponse>
      <Events xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Events>
      <Id>String</Id>
      <Url>String</Url>
    </StripeWebhookResponse>
  </StripeWebhooks>
</StripeWebhooksResponse>