| 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 |
import java.math.*
import java.util.*
import net.servicestack.client.*
open class TestSubscription : ApiServiceRequest(), ILogRequest
{
/**
* The event type being subscribed to
*/
@ApiMember(Description="The event type being subscribed to", IsRequired=true)
var EventType:WebhookSubscriptionEventType? = null
}
open class ApiServiceRequest : IServiceRequest, IHasApiKey
{
/**
* The API Key required for authentication
*/
@ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
var ApiKey:String? = null
}
enum class WebhookSubscriptionEventType(val value:Int)
{
@SerializedName("0") DriverOnTheWay(0),
@SerializedName("1") ArrivedAtWaypoint(1),
@SerializedName("2") DepartedWaypoint(2),
@SerializedName("3") OrderCompleted(3),
@SerializedName("4") OrderCancelled(4),
}
open class ApiServiceResponse : IServiceResponse
{
/**
* Information about the response.
*/
@ApiMember(Description="Information about the response.", IsRequired=true)
var Description:String? = null
/**
* Heading or summary of the response.
*/
@ApiMember(Description="Heading or summary of the response.", IsRequired=true)
var Heading:String? = null
/**
* Did the intended operation for this response complete successfully?
*/
@ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
var WasSuccessful:Boolean? = null
}
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.
POST /subscription/test HTTP/1.1
Host: 1fetch.api.client.prod.86degrees.com
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"EventType":0,"ApiKey":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Description":"String","Heading":"String","WasSuccessful":false}