| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /webhook/endpoints/{id} | Update 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 UpdateWebhookEndpoint 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 The ID of the webhook endpoint. */
// @ApiMember(Description="The ID of the webhook endpoint.", IsRequired=true, ParameterType="path")
public Id: 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;
public Disabled: boolean;
public constructor(init?: Partial<UpdateWebhookEndpoint>) { (Object as any).assign(this, init); }
}
TypeScript UpdateWebhookEndpoint DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /webhook/endpoints/{id} HTTP/1.1
Host: testapi.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
Url: String,
Id: String,
EventTypes:
[
String
],
Description: String,
Disabled: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Description: String,
Url: String,
Id: String,
Disabled: False,
EventTypes:
[
String
]
}