| GET | /subscription | Get a list of subscription events that you are subscribed to |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | form | string | Yes | The API Key required for authentication |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Subscriptions | form | List<SubscriptionDetail> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Description | form | string | Yes | Information about the response. |
| Heading | form | string | Yes | Heading or summary of the response. |
| WasSuccessful | form | boolean | Yes | Did the intended operation for this response complete successfully? |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EventType | form | WebhookSubscriptionEventType | No | |
| EventName | form | string | No | |
| SubscriptionUrl | form | string | No |
| Name | Value | |
|---|---|---|
| DriverOnTheWay | 0 | |
| ArrivedAtWaypoint | 1 | |
| DepartedWaypoint | 2 | |
| OrderCompleted | 3 | |
| OrderCancelled | 4 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /subscription HTTP/1.1 Host: api.1fetch.co.za Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Subscriptions":[{"EventType":0,"EventName":"String","SubscriptionUrl":"String"}],"Description":"String","Heading":"String","WasSuccessful":false}