Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
PUT | /webhook/endpoints/{id} | Update webhook endpoint |
---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Namespace Global
Namespace BokaMera.API.ServiceModel.Dtos
<ApiResponse(Description:="You were unauthorized to call this service", StatusCode:=401)>
<ValidateRequest(Validator:="IsAuthenticated")>
Public Partial Class UpdateWebhookEndpoint
Implements ICompany
Public Sub New()
EventTypes = New List(Of String)
End Sub
'''<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 Overridable Property CompanyId As Nullable(Of Guid)
'''<Summary>
'''The webhook endpoint URL.
'''</Summary>
<ApiMember(Description:="The webhook endpoint URL.", IsRequired:=true)>
Public Overridable Property Url As String
'''<Summary>
'''The ID of the webhook endpoint.
'''</Summary>
<ApiMember(Description:="The ID of the webhook endpoint.", IsRequired:=true, ParameterType:="path")>
Public Overridable Property Id As String
'''<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.")>
Public Overridable Property EventTypes As List(Of String)
Public Overridable Property Description As String
Public Overridable Property Disabled As Boolean
End Class
Public Partial Class WebhookEndpoint
Public Sub New()
EventTypes = New List(Of String)
End Sub
Public Overridable Property Description As String
Public Overridable Property Url As String
Public Overridable Property Id As String
Public Overridable Property Disabled As Boolean
Public Overridable Property EventTypes As List(Of String)
End Class
End Namespace
End Namespace
VB.NET UpdateWebhookEndpoint DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
Content-Type: text/jsonl
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: text/jsonl Content-Length: length {"Description":"String","Url":"String","Id":"String","Disabled":false,"EventTypes":["String"]}