Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
POST | /webhook/endpoints | Create webhook endpoint |
---|
import Foundation
import ServiceStack
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class CreateWebhookEndpoint : 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:Uri
/**
* 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
// @ApiMember()
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 CreateWebhookEndpoint DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","EventTypes":["String"],"Description":"String","Disabled":false}
HTTP/1.1 200 OK Content-Type: text/jsonl Content-Length: length {"Description":"String","Url":"String","Id":"String","Disabled":false,"EventTypes":["String"]}