Update existing Webhook subscription | Close | Developer API Documentation

curl -X PUT https://api.close.com/api/v1/webhook/id/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "status": "paused"
}'

{
  "counters": {},
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "date_created": "2018-12-06T19:15:09.590432",
  "date_updated": "2018-12-06T19:21:12.226090",
  "events": [
    {
      "action": "created",
      "object_type": "lead"
    },
    {
      "action": "updated",
      "object_type": "lead"
    },
    {
      "action": "created",
      "object_type": "activity.call"
    },
    {
      "action": "created",
      "object_type": "activity.note"
    },
    {
      "action": "updated",
      "object_type": "activity.note"
    }
  ],
  "health_status": "healthy",
  "id": "whsub_6un6NQjYTaFdgtIZsTDXP6",
  "pause_reason": "api",
  "recent_consecutive_fail_buckets_cnt": 0,
  "signature_key": "058bfb6a3d8cfdc4da7c3be5901b16ae11da982b46a25fb2cd7016e97a140a1c",
  "status": "paused",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "url": "https://test.example.com",
  "verify_ssl": true
}

All parameters are optional. Only the parameters that are provided will be updated.

Parameters:

url - Destination URL for the webhook subscription
events - A list of events to subscribe to. Each event has an object_type and an action from values in the event log. You can also use Webhook Filters while creating your subscription so that an event only fires to a Webhook when certain conditions are met.
status - Subscription status
- active - activate the subscription
- paused - pause the subscription
verify_ssl
- false - Disable SSL certificate validation on destination webhook URL. We recommend using https to protect your data during delivery.
- true - Verify SSL certificate of destination webhook URL.

All parameters are optional. Only the parameters that are provided will be updated. Parameters: - `url` - Destination URL for the webhook subscription - `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 Webhook when certain conditions are met. - `status` - Subscription status - `active` - activate the subscription - `paused` - pause the subscription - `verify_ssl` - `false` - Disable SSL certificate validation on destination webhook URL. We recommend using https to protect your data during delivery. - `true` - Verify SSL certificate of destination webhook URL.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:)>.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Request

This endpoint expects any.

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

All parameters are optional. Only the parameters that are provided will be updated.

Parameters:

url - Destination URL for the webhook subscription
events - A list of events to subscribe to. Each event has an object_type and an action from values in the event log. You can also use Webhook Filters while creating your subscription so that an event only fires to a Webhook when certain conditions are met.
status - Subscription status
- active - activate the subscription
- paused - pause the subscription
verify_ssl
- false - Disable SSL certificate validation on destination webhook URL. We recommend using https to protect your data during delivery.
- true - Verify SSL certificate of destination webhook URL.