Capsule CRM Webhook Setup Guide

Capsule only allows registered OAuth applications, authorized by an account Administrator, to create REST Hook subscriptions. Connect the account using the OAuth 2.0 authentication method — API Key connections cannot provision webhooks and will not receive any events.

When the connection is established, StackOne generates a unique callback URL for it and automatically subscribes a Capsule REST Hook for each webhook event you enable in StackOne. Only the events you enable are subscribed. Capsule allows a maximum of 20 active REST Hook subscriptions per account, so enable only the events you intend to consume.

Fired for people and organisations (Capsule “parties”).

• Party Created (party/created) — Fired when a new contact (person or organisation) is created.
• Party Updated (party/updated) — Fired when a contact’s details are changed.
• Party Deleted (party/deleted) — Fired when a contact is deleted.

Fired for projects (referred to as “cases” in the API, event code kase/*).

• Project Created (kase/created) — Fired when a new project is created.
• Project Updated (kase/updated) — Fired when a project’s details are changed.
• Project Deleted (kase/deleted) — Fired when a project is deleted.
• Project Closed (kase/closed) — Fired when a project is closed.
• Project Moved (kase/moved) — Fired when a project is moved to a different stage.

Fired for sales opportunities.

• Opportunity Created (opportunity/created) — Fired when a new opportunity is created.
• Opportunity Updated (opportunity/updated) — Fired when an opportunity’s details are changed.
• Opportunity Deleted (opportunity/deleted) — Fired when an opportunity is deleted.
• Opportunity Closed (opportunity/closed) — Fired when an opportunity is closed (won or lost).
• Opportunity Moved (opportunity/moved) — Fired when an opportunity is moved to a different pipeline stage.

Fired for tasks.

• Task Created (task/created) — Fired when a new task is created.
• Task Updated (task/updated) — Fired when a task’s details are changed.
• Task Completed (task/completed) — Fired when a task is marked as completed.

Fired for user accounts on the Capsule account.

• User Created (user/created) — Fired when a new user is added to the account.
• User Updated (user/updated) — Fired when a user’s details are changed.
• User Deleted (user/deleted) — Fired when a user is removed from the account.

Capsule sends each event as an HTTP POST with a JSON body containing the trigger name in an event field (for example party/updated) and a payload field holding an array of the affected records.

Capsule may batch several records affected by the same event into a single delivery, so the payload array can contain more than one record. StackOne forwards the full payload array in a single emitted event.

Capsule REST Hook deliveries are not signed. StackOne verifies each delivery through the unique, unguessable callback URL generated for the connection.