BokaMera.API.Host

<back to all web services

GetWebhookEndpoint

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

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class GetWebhookEndpoint : 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 ID of the webhook endpoint.
    */
    // @ApiMember(Description="The ID of the webhook endpoint.", IsRequired=true, ParameterType="path")
    public var id:String

    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 GetWebhookEndpoint 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.

GET /webhook/endpoints/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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