| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| GET | /webhook/endpoints/{Id} | Get endpoint |
|---|
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 WebhookEndpoint:
description: Optional[str] = None
url: Optional[str] = None
id: Optional[str] = None
disabled: bool = False
event_types: List[str] = field(default_factory=list)
secret: Optional[str] = None
# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetWebhookEndpoint(ICompany):
# @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.", IsRequired=true, ParameterType="query")
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="The ID of the webhook endpoint.", IsRequired=true, ParameterType="path")
id: Optional[str] = None
"""
The ID of the webhook endpoint.
"""
# @ApiMember(Description="Include Endpoint secret in the response. Default is false.")
include_secret: bool = False
"""
Include Endpoint secret in the response. Default is false.
"""
Python GetWebhookEndpoint DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /webhook/endpoints/{Id} HTTP/1.1
Host: api.bookmore.com
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Description":"String","Url":"String","Id":"String","Disabled":false,"EventTypes":["String"],"Secret":"String"}