| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /webhook/endpoints | Create webhook endpoint |
|---|
namespace BokaMera.API.ServiceModel.Dtos
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type WebhookEndpoint() =
member val Description:String = null with get,set
member val Url:String = null with get,set
member val Id:String = null with get,set
member val Disabled:Boolean = new Boolean() with get,set
member val EventTypes:ResizeArray<String> = new ResizeArray<String>() with get,set
[<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
[<ValidateRequest(Validator="IsAuthenticated")>]
[<AllowNullLiteral>]
type CreateWebhookEndpoint() =
///<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")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///The webhook endpoint URL.
///</summary>
[<ApiMember(Description="The webhook endpoint URL.", IsRequired=true)>]
member val Url:Uri = null with 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(Validator="NotEmpty", ErrorCode="At least one event type is required.")>]
member val EventTypes:ResizeArray<String> = new ResizeArray<String>() with get,set
member val Description:String = null with get,set
[<ApiMember>]
member val Disabled:Boolean = new Boolean() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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: testapi.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>