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
CreateStripeWebhook Parameters:
NameParameterData TypeRequiredDescription
CompanyIdbodyGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
EventsbodyList<string>NoEvents (webhooks) that are accepted by stripe.
UrlbodystringNoUrl that stripe should send hook to.
StripeWebhookResponse Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
EventsformList<string>No
UrlformstringNo

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.

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

<CreateStripeWebhook xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Events xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Events>
  <Url>String</Url>
</CreateStripeWebhook>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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