BokaMera.API.Host

<back to all web services

CreateStripeWebhook

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin
The following routes are available for this service:
POST/payment/stripe/v1/webhookCreate stripe webhook with all events: By default it will create webhook set in settings with all events covered in bokameraCreate stripe webhook with all 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 CreateStripeWebhook 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 Events (webhooks) that are accepted by stripe. */
    // @ApiMember(Description="Events (webhooks) that are accepted by stripe.")
    public Events: string[];

    /** @description Url that stripe should send hook to. */
    // @ApiMember(Description="Url that stripe should send hook to.")
    public Url: string;

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

TypeScript CreateStripeWebhook DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /payment/stripe/v1/webhook HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Events":["String"],"Url":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Id":"String","Events":["String"],"Url":"String"}