Webhooks

Webhooks will POST an object to a target URL when certain events happen. Updated object(s) will be in an array. If the POST request gets a http 410 Gone response, the webhook will delete itself. If it gets a response other than 200 or 410, the webhook will retry with a backoff delay.

Property Name

Description

event

type of webhook event

targetUrl

url to POST the updated object to

Webhook Events

The event specified will decide the type of object that is sent.

Event Name

Category

Object Type

Description

BOX_CREATE

Pipeline

Box

When a new box is created

BOX_DELETE

Pipeline

Box

When a box is deleted

STAGE_CREATE

Pipeline

Stage

When a new stage is created

BOX_NEW_EMAIL_ADDRESS

Pipeline

Box

When a new email address is detected on a box

BOX_EDIT

Pipeline

Box

When a custom field, notes, assigned to, or name is edited on a box

BOX_CHANGE_STAGE

Pipeline

Box

When a box changes stage

BOX_CHANGE_PIPELINE

Pipeline

Box

When a box changes pipeline

COMMENT_CREATE

Pipeline

Comment

When a comment is created

MEETING_CREATE

Pipeline

Meeting note/Call log

When a meeting note or call log is created in a box

MEETING_UPDATE

Pipeline

Meeting note/Call log

When a change to a meeting note or call log is made

TASK_CREATE

Pipeline

Task

When a task is created

TASK_COMPLETE

Pipeline

Task

When a task is complete

TASK_DUE

Pipeline

Task

When a task is due

CONTACT_CREATE

Team

Contact

When a contact is created

ORG_CREATE

Team

Organization

When an organization is created

CONTACT_UPDATE

Team

Contact

When a contact is updated

ORG_UPDATE

Team

Organization

When an organization is updated

CONTACT_DELETE

Team

Contact

When a contact is deleted

ORG_DELETE

Team

Organization

When an organization is deleted