1Fetch Client API

<back to all web services

TestSubscription

The following routes are available for this service:
GET,POST/subscription/testFire a test to one of your webhooks
GET,POST/subscription/test/{EventType}Fire a test to one of your webhooks
TestSubscription Parameters:
NameParameterData TypeRequiredDescription
EventTypepathWebhookSubscriptionEventTypeYesThe event type being subscribed to

Allowable Values

  • DriverOnTheWay
  • ArrivedAtWaypoint
  • DepartedWaypoint
  • OrderCompleted
  • OrderCancelled
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 .other suffix or ?format=other

HTTP + 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: api.1fetch.co.za 
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}