1Fetch Client API

<back to all web services

UpdateSubscription

The following routes are available for this service:
PUT/subscription/{EventType}Update your subscription to an event with a url we should post to
PUT/subscriptionUpdate your subscription to an event with a url we should post to
UpdateSubscription Parameters:
NameParameterData TypeRequiredDescription
EventTypepathWebhookSubscriptionEventTypeYesThe event type being subscribed to

Allowable Values

  • DriverOnTheWay
  • ArrivedAtWaypoint
  • DepartedWaypoint
  • OrderCompleted
  • OrderCancelled
SubscriptionUrlbodystringYesThe URL we should post the event data to
ApiServiceRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyformstringYesThe API Key required for authentication
WebhookSubscriptionEventType Enum:
NameValue
DriverOnTheWay0
ArrivedAtWaypoint1
DepartedWaypoint2
OrderCompleted3
OrderCancelled4
ApiServiceResponse Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYesInformation about the response.
HeadingformstringYesHeading or summary of the response.
WasSuccessfulformbooleanYesDid the intended operation for this response complete successfully?

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

PUT /subscription/{EventType} HTTP/1.1 
Host: api.1fetch.co.za 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"EventType":0,"SubscriptionUrl":"String","ApiKey":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Description":"String","Heading":"String","WasSuccessful":false}