BokaMera.API.Host

<back to all web services

UpdateStripeWebhookEvents

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin
The following routes are available for this service:
PUT/payment/stripe/v1/webhookeventUpdate stripe webhook eventsUpdate stripe webhook events
"use strict";
export class StripeWebhookResponse {
    /** @param {{Id?:string,Events?:string[],Url?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string[]} */
    Events;
    /** @type {string} */
    Url;
}
export class StripeWebhooksResponse {
    /** @param {{StripeWebhooks?:StripeWebhookResponse[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {StripeWebhookResponse[]} */
    StripeWebhooks;
}
export class UpdateStripeWebhookEvents {
    /** @param {{CompanyId?:string,Events?:string[],WebhookId?: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 Events (webhooks) that are accepted by stripe. */
    Events;
    /**
     * @type {string}
     * @description Webhook Id to update events */
    WebhookId;
}

JavaScript UpdateStripeWebhookEvents DTOs

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

HTTP + JSV

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

PUT /payment/stripe/v1/webhookevent HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

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