{ "opencollection": "1.0.0", "info": { "name": "API Endpoints subpackage_activities subpackage_webhooks API", "version": "1.0.0" }, "items": [ { "info": { "name": "subpackage_webhooks", "type": "folder" }, "items": [ { "info": { "name": "List Webhook subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/webhook/", "headers": [ { "name": "Authorization", "value": "" } ] }, "docs": "List all webhook subscriptions for the organization." }, { "info": { "name": "Create new Webhook subscription", "type": "http" }, "http": { "method": "POST", "url": "https://api.close.com/api/v1/webhook/", "headers": [ { "name": "Authorization", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The subscription will send events to the specified URL.\n\nParameters:\n - `url` - Destination URL for the webhook subscription\n - `events` - A list of events to subscribe to. Each event has an `object_type` and an `action` from values in the [event log](https://developer.close.com/api/resources/events/list-of-event-types). You can also use [Webhook Filters](https://developer.close.com/api/resources/webhooks/webhook-filters) while creating your subscription so that an event only fires to a Webhoo" }, { "info": { "name": "Retrieve a single Webhook subscription", "type": "http" }, "http": { "method": "GET", "url": "https://api.close.com/api/v1/webhook/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "The response contains the subscription details." }, { "info": { "name": "Update existing Webhook subscription", "type": "http" }, "http": { "method": "PUT", "url": "https://api.close.com/api/v1/webhook/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "All parameters are optional. Only the parameters that are provided will be updated.\n\nParameters:\n - `url` - Destination URL for the webhook subscription\n - `events` - A list of events to subscribe to. Each event has an `object_type` and an `action` from values in the [event log](https://developer.close.com/api/resources/events/list-of-event-types). You can also use [Webhook Filters](https://developer.close.com/api/resources/webhooks/webhook-filters) while creating your subscription so that an " }, { "info": { "name": "Delete Webhook subscription", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.close.com/api/v1/webhook/:id/", "headers": [ { "name": "Authorization", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete Webhook subscription" } ] } ], "bundled": true }