| DELETE | /subscription/{EventType} | Unsubscribe from an event notification | |
|---|---|---|---|
| DELETE | /subscription | Unsubscribe from an event notification |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EventType | path | WebhookSubscriptionEventType | Yes | The event type being removedAllowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | form | string | Yes | The API Key required for authentication |
| Name | Value | |
|---|---|---|
| DriverOnTheWay | 0 | |
| ArrivedAtWaypoint | 1 | |
| DepartedWaypoint | 2 | |
| OrderCompleted | 3 | |
| OrderCancelled | 4 |
| 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? |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
DELETE /subscription/{EventType} HTTP/1.1
Host: api.1fetch.co.za
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Description: String,
Heading: String,
WasSuccessful: False
}