BokaMera.API.Host

<back to all web services

UpdateWebhookEndpoint

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/webhook/endpoints/{id}Update webhook endpoint
import Foundation
import ServiceStack

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class UpdateWebhookEndpoint : ICompany, Codable
{
    /**
    * 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 var companyId:String?

    /**
    * The webhook endpoint URL.
    */
    // @ApiMember(Description="The webhook endpoint URL.", IsRequired=true)
    public var url:String

    /**
    * The ID of the webhook endpoint.
    */
    // @ApiMember(Description="The ID of the webhook endpoint.", IsRequired=true, ParameterType="path")
    public var id:String

    /**
    * 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 var eventTypes:[String] = []

    public var Description:String
    public var disabled:Bool

    required public init(){}
}

public class WebhookEndpoint : Codable
{
    public var Description:String
    public var url:String
    public var id:String
    public var disabled:Bool
    public var eventTypes:[String] = []

    required public init(){}
}


Swift UpdateWebhookEndpoint 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.

PUT /webhook/endpoints/{id} HTTP/1.1 
Host: api.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
	]
}