BokaMera.API.Host

CreateWebhookEndpoint

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
POST	/webhook/endpoints	Create webhook 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 CreateWebhookEndpoint
        : ICompany
    {
        public CreateWebhookEndpoint()
        {
            EventTypes = new List<string>{};
        }

        ///<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 webhook endpoint URL.
        ///</summary>
        [ApiMember(Description="The webhook endpoint URL.", IsRequired=true)]
        public virtual Uri Url { get; set; }

        ///<summary>
        ///List of event types. At least one event type is required.
        ///</summary>
        [ApiMember(Description="List of event types. At least one event type is required.", IsRequired=true)]
        [Validate("NotEmpty", ErrorCode="At least one event type is required.")]
        public virtual List<string> EventTypes { get; set; }

        public virtual string Description { get; set; }
        [ApiMember]
        public virtual bool Disabled { 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# CreateWebhookEndpoint DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CreateWebhookEndpoint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Description>String</Description>
  <Disabled>false</Disabled>
  <EventTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EventTypes>
  <Url i:nil="true" />
</CreateWebhookEndpoint>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WebhookEndpoint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Description>String</Description>
  <Disabled>false</Disabled>
  <EventTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EventTypes>
  <Id>String</Id>
  <Url>String</Url>
</WebhookEndpoint>