| GET,POST | /subscription/test | Fire a test to one of your webhooks | |
|---|---|---|---|
| GET,POST | /subscription/test/{EventType} | Fire a test to one of your webhooks |
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports WebService.ClientServiceModel.Subscription
Imports WebService.ClientServiceModel.Base
Imports BusinessLogic.Entities
Imports CommonService.Api.Models.Base
Namespace Global
Namespace BusinessLogic.Entities
Public Enum WebhookSubscriptionEventType
MessageReceived = 1
End Enum
End Namespace
Namespace CommonService.Api.Models.Base
Public Partial Class ApiServiceResponse
Implements IServiceResponse
Public Overridable Property Description As String
Public Overridable Property Heading As String
Public Overridable Property WasSuccessful As Boolean
Public Overridable Property ModelState As Object
End Class
End Namespace
Namespace WebService.ClientServiceModel.Base
Public Partial Class ApiServiceRequest
Implements IServiceRequest
Implements IHasApiKey
'''<Summary>
'''The API Key required for authentication
'''</Summary>
<ApiMember(DataType:="string", Description:="The API Key required for authentication", IsRequired:=true)>
Public Overridable Property ApiKey As String
End Class
End Namespace
Namespace WebService.ClientServiceModel.Subscription
Public Partial Class TestSubscription
Inherits ApiServiceRequest
Implements ILogRequest
'''<Summary>
'''The event type being subscribed to
'''</Summary>
<ApiMember(Description:="The event type being subscribed to", IsRequired:=true)>
Public Overridable Property EventType As WebhookSubscriptionEventType
End Class
End Namespace
End Namespace
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /subscription/test HTTP/1.1
Host: galaxymobile.api.client.prod.86degrees.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
EventType: 1,
ApiKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Description: String,
Heading: String,
WasSuccessful: False,
ModelState: {}
}