BokaMera.API.Host

<back to all web services

CreateWebhookEndpoint

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/webhook/endpointsCreate webhook endpoint

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); }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class CreateWebhookEndpoint 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;

    /** @description The webhook endpoint URL. */
    // @ApiMember(Description="The webhook endpoint URL.", IsRequired=true)
    public Url: string;

    /** @description List of event types. At least one event type is required. */
    // @ApiMember(Description="List of event types. At least one event type is required.", IsRequired=true)
    // @Validate(Validator="NotEmpty", ErrorCode="At least one event type is required.")
    public EventTypes: string[];

    public Description: string;
    // @ApiMember()
    public Disabled: boolean;

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

TypeScript CreateWebhookEndpoint DTOs

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

HTTP + CSV

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

POST /webhook/endpoints HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","EventTypes":["String"],"Description":"String","Disabled":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Description":"String","Url":"String","Id":"String","Disabled":false,"EventTypes":["String"]}