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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
    @ValidateRequest(Validator="IsAuthenticated")
    public static class UpdateWebhookEndpoint implements ICompany
    {
        /**
        * 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 UUID CompanyId = null;

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

        /**
        * The ID of the webhook endpoint.
        */
        @ApiMember(Description="The ID of the webhook endpoint.", IsRequired=true, ParameterType="path")
        public String Id = null;

        /**
        * 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 ArrayList<String> EventTypes = null;

        public String Description = null;
        public Boolean Disabled = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public UpdateWebhookEndpoint setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public String getUrl() { return Url; }
        public UpdateWebhookEndpoint setUrl(String value) { this.Url = value; return this; }
        public String getId() { return Id; }
        public UpdateWebhookEndpoint setId(String value) { this.Id = value; return this; }
        public ArrayList<String> getEventTypes() { return EventTypes; }
        public UpdateWebhookEndpoint setEventTypes(ArrayList<String> value) { this.EventTypes = value; return this; }
        public String getDescription() { return Description; }
        public UpdateWebhookEndpoint setDescription(String value) { this.Description = value; return this; }
        public Boolean isDisabled() { return Disabled; }
        public UpdateWebhookEndpoint setDisabled(Boolean value) { this.Disabled = value; return this; }
    }

    public static class WebhookEndpoint
    {
        public String Description = null;
        public String Url = null;
        public String Id = null;
        public Boolean Disabled = null;
        public ArrayList<String> EventTypes = null;
        
        public String getDescription() { return Description; }
        public WebhookEndpoint setDescription(String value) { this.Description = value; return this; }
        public String getUrl() { return Url; }
        public WebhookEndpoint setUrl(String value) { this.Url = value; return this; }
        public String getId() { return Id; }
        public WebhookEndpoint setId(String value) { this.Id = value; return this; }
        public Boolean isDisabled() { return Disabled; }
        public WebhookEndpoint setDisabled(Boolean value) { this.Disabled = value; return this; }
        public ArrayList<String> getEventTypes() { return EventTypes; }
        public WebhookEndpoint setEventTypes(ArrayList<String> value) { this.EventTypes = value; return this; }
    }

}

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

PUT /webhook/endpoints/{id} HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
Content-Type: application/json
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: application/json
Content-Length: length

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