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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StripeWebhookResponse:
    id: Optional[str] = None
    events: Optional[List[str]] = None
    url: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateStripeWebhook(ICompany):
    # @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    company_id: Optional[str] = None
    """
    The company id, if empty will use the company id for the user you are logged in with.
    """


    # @ApiMember(Description="Events (webhooks) that are accepted by stripe.")
    events: Optional[List[str]] = None
    """
    Events (webhooks) that are accepted by stripe.
    """


    # @ApiMember(Description="Should webhook listen to customer events's")
    connect: bool = False
    """
    Should webhook listen to customer events's
    """


    # @ApiMember(Description="Url that stripe should send hook to.")
    url: Optional[str] = None
    """
    Url that stripe should send hook to.
    """

Python CreateStripeWebhook 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.

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>
  <Connect>false</Connect>
  <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>