1Fetch Client API

<back to all web services

SubscriptionEvents

The following routes are available for this service:
GET/subscription/eventsGet a list of subscription event types
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
SubscriptionEventsResponse Parameters:
NameParameterData TypeRequiredDescription
SubscriptionEventsDescriptionsformList<SubscriptionEventsDescription>No
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYesInformation about the response.
HeadingformstringYesHeading or summary of the response.
WasSuccessfulformbooleanYesDid the intended operation for this response complete successfully?
SubscriptionEventsDescription Parameters:
NameParameterData TypeRequiredDescription
EventTypeformWebhookSubscriptionEventTypeNo
EventNameformstringNo
EventDescriptionformstringNo
WebhookSubscriptionEventType Enum:
NameValue
DriverOnTheWay0
ArrivedAtWaypoint1
DepartedWaypoint2
OrderCompleted3
OrderCancelled4

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /subscription/events HTTP/1.1 
Host: 1fetch.api.client.prod.86degrees.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	SubscriptionEventsDescriptions: 
	[
		{
			EventType: 0,
			EventName: String,
			EventDescription: String
		}
	],
	Description: String,
	Heading: String,
	WasSuccessful: False
}