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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

namespace BokaMera.API.ServiceModel.Dtos
{
    [ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
    [ValidateRequest("IsAuthenticated")]
    public partial class GetWebhookEndpoint
        : ICompany
    {
        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [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 virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///The ID of the webhook endpoint.
        ///</summary>
        [ApiMember(Description="The ID of the webhook endpoint.", IsRequired=true, ParameterType="path")]
        public virtual string Id { get; set; }
    }

    public partial class WebhookEndpoint
    {
        public WebhookEndpoint()
        {
            EventTypes = new List<string>{};
        }

        public virtual string Description { get; set; }
        public virtual string Url { get; set; }
        public virtual string Id { get; set; }
        public virtual bool Disabled { get; set; }
        public virtual List<string> EventTypes { get; set; }
    }

}

C# 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"]}