Create new Webhook subscription | Close | Developer API Documentation

curl -X POST https://api.close.com/api/v1/webhook/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "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"
    },
    {
      "action": "created",
      "object_type": "activity.form_submission"
    }
  ],
  "url": "https://test.example.com"
}'

{
  "counters": {},
  "created_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "date_created": "2018-12-06T19:15:09.590432",
  "date_updated": "2018-12-06T19:15:09.590439",
  "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",
  "recent_consecutive_fail_buckets_cnt": 0,
  "signature_key": "058bfb6a3d8cfdc4da7c3be5901b16ae11da982b46a25fb2cd7016e97a140a1c",
  "status": "active",
  "updated_by": "user_N6KhMpzHRCYQHdn4gRNIFNN5JExnsrprKA6ekxM63XA",
  "url": "https://test.example.com",
  "verify_ssl": true
}

The subscription will send events to the specified URL.

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.
verify_ssl (optional)
- true (default) - Verify SSL certificate of destination webhook URL.
- false - Disable SSL certificate validation on destination webhook URL. We recommend using https to protect your data during delivery.

The subscription will send events to the specified URL. 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](/resources/event-log/list-of-events/). You can also use [Webhook Filters](/resources/webhook-subscriptions/webhook-filters/) while creating your subscription so that an event only fires to a Webhook when certain conditions are met. - `verify_ssl` (optional) - `true` (default) - Verify SSL certificate of destination webhook URL. - `false` - Disable SSL certificate validation on destination webhook URL. We recommend using https to protect your data during delivery.

Authentication

AuthorizationBasic

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

AuthorizationBearer

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

Request

This endpoint expects an object.

eventslist of objectsRequired

urlstringRequired

event_filtermap from strings to any or nullOptional

verify_sslbooleanOptionalDefaults to true

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error