BokaMera.API.Host

<back to all web services

ListWebhookEndpoint

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
GET/webhook/endpointsList webhook endpoints

export class WebhookEndpoint
{
    public Description: string;
    public Url: string;
    public Id: string;
    public Disabled: boolean;
    public EventTypes: string[];

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

export class ListEndpointsResponse
{
    public Endpoints: WebhookEndpoint[];

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

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class ListWebhookEndpoint 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.", IsRequired=true, ParameterType="query")
    public CompanyId: string;

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

TypeScript ListWebhookEndpoint 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.

GET /webhook/endpoints HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Endpoints: 
	[
		{
			Description: String,
			Url: String,
			Id: String,
			Disabled: False,
			EventTypes: 
			[
				String
			]
		}
	]
}