Working with webhooks

Our webhooks API is a mechanism that allows Nutshell to fire a JSON payload to a URL that you supply when certain events happen in Nutshell.

Instead of having to periodically poll Nutshell to see if things have changed, Nutshell will notify your system when certain events occur. This webhook payload can then be used by your system as a trigger.

Manage your webhook subscriptions

To create an outgoing webhook, you can use the Nutshell web UI, under Setup > API keys . You do not need to choose what kinds of events to send per webhook: all webhooks receive a firehose of events.

Qualifying events which emit webhooks

Changes to the following entities will cause a webhook event to be emitted. The webhook payload can be caught and processed by your application

📘

This is only a partial list of webhook emitting events

We generally bias toward emitting more events, so you may discover additional incoming webhooks. We recommend filtering to just the events that matter to your application

• People (contacts)
  • Changes to various attributes (i.e. name, address, phone number, custom field)
  • Notes added
  • Contact is merged
  • File is uploaded
  • Description is updated
  • Owner / assignee is changed
• Companies (accounts)
  • Changes to various attributes (i.e. name, address, phone number, industry, company type, custom field)
  • Notes added
  • Contact is merged
  • File is uploaded
  • Description is updated
  • Owner / assignee is changed
• Leads
  • Changes to various attributes (i.e. description, due time, confidence)
  • Stage changes
  • Outcome changes (lead is won / lost / canceled)
  • Lead is merged
  • Value changes (i.e. a product is modified on the lead)
  • Notes are added
• Activities
  • Changes to name, description, time, etc
  • Status (scheduled, logged, canceled)
• Scheduler bookings
  • Webhooks are emitted when a Nutshell Scheduler booking is received
• Form submissions
  • Webhooks are emitted when a Nutshell Form is submitted.