photo-front/documentation/api/PostWebhookDelete.markdown

Open Photo API / Delete Webhook

OpenPhoto, a photo service for the masses

---

1. Purpose
2. Endpoint
3. Parameters
4. Examples

• Command line
• PHP

1. Response

• Sample

---

Purpose of the POST Webhook delete API

Use this API to delete an existing webhook for a user.

---

Endpoint

Authentication: required

POST /webhook/:id/delete.json

Parameters

None

---

Examples

Command Line (using openphoto-php)

source secrets.sh
./openphoto -p -X POST -h current.openphoto.me -e /webhook/abcdefghijklmnopqrstuvwxyz/delete.json

PHP (using openphoto-php)

$client = new OpenPhotoOAuth($host, $consumerKey, $consumerSecret, $oauthToken, $oauthTokenSecret);
$response = $client->post('/webhook/abcdefghijklmnopqrstuvwxyz/delete.json');

---

Response

The response is in a standard response envelope.

• message, A string describing the result. Don't use this for anything but reading.
• code, 200 on success
• result, A boolean

Sample

{
  "message" : "Webhook deleted successfully",
  "code" : 200,
  "result" : true
}