BokaMera.API.Host

<back to all web services

UpdateWebhookSettingsRequest

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/webhook/settingsEnable or disable webhook feature for the companySets the webhook feature flag for the company identified by the API key in the header

export class WebhookSettingsResponse
{
    public Enabled: boolean;
    public Message: string;
    public CompanyId: string;

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

export class UpdateWebhookSettingsRequest 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;

    // @Required()
    // @ApiMember()
    public Enabled: boolean;

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

TypeScript UpdateWebhookSettingsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

PUT /webhook/settings HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Enabled":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Enabled":false,"Message":"String"}