photo-documentation/docs/api/PostWebhookDelete.markdown
2013-01-28 22:49:14 -05:00

2 KiB

Delete Webhook


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

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, 204 on success
  • result, A boolean

Sample

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