Events
Event Types
This page lists the different event types which will send an event object to your registered webhook endpoints:
| Event Type | Description | Resource |
|---|---|---|
| client.created | Client is created | Clients |
| client.activated | Client authenticates in the portal for the first time | Clients |
| client.updated* | Any properties for a client are modified | Clients |
| client.deleted | Client is put into an irreversible, deleted state | Clients |
| company.created | Company is created | Companies |
| company.updated | Any properties for a company are modified | Companies |
| company.customFields.updated | Custom fields are updated for a company | Companies |
| company.deleted | Company is put into an irreversible, deleted state | Companies |
| contract.requested | Contract has been assigned to a client by an internal user | Contracts |
| contract.signed | Contract has been signed by a client | Contracts |
| file.created | A new file has been uploaded to a file channel | Files |
| file.updated | A file has been renamed or moved within a file channel | Files |
| file.deleted | A file has been deleted within a file channel | Files |
| folder.created | A new folder has been created in a file channel | Files |
| folder.updated | A folder has been renamed or moved within a file channel | Files |
| folder.deleted | A folder has been deleted within a file channel | Files |
| formResponse.completed | Form response has been submitted by a client | Form Responses |
| internalUser.created | An Internal User has been created in the workspace | Internal Users |
| internalUser.deleted | An Internal User has been deleted from the workspace | Internal Users |
| invoice.created | An invoice has been created | Invoices |
| invoice.deleted | An invoice has been deleted | Invoices |
| invoice.paid | An invoice has been paid | Invoices |
| invoice.sent | An invoice has been sent to the client to pay | Invoices |
| invoice.updated | An invoice has been updated | Invoices |
| invoice.voided | An invoice has been voided | Invoices |
| link.created | A new link has been created in a file channel | Files |
| link.updated | A link has been renamed or moved within a file channel | Files |
| link.deleted | A link has been deleted within a file channel | Files |
| message.sent | Message has been sent (by a client or internal user) | Messages |
| messageChannel.created | A message channel has been created in the workspace | Message Channels |
| messageChannel.deleted | A message channel has been deleted in the workspace | Message Channels |
| note.created | A new note is created on a client or a company | Notes |
| note.deleted | A note has been updated | Notes |
| note.updated | A note has been deleted | Notes |
| notification.created | Notification has been sent to a client or internal user | Notifications |
| payment.succeeded | Payment for an invoice succeeded | Payments |
| payment.failed | Payment for the invoice failed | Payments |
| price.created | A new price is created for a product | Prices |
| product.created | A product has been created | Products |
| product.updated | A product has been updated | Products |
| subscription.canceled | A subscription has been canceled | Subscriptions |
| subscription.created | A subscription is created | Subscriptions |
| task.archived | A task has been archived | Tasks |
| task.completed | A task has been completed | Tasks |
| task.created | A task is created | Tasks |
| task.deleted | A task has been deleted | Tasks |
| task.updated | A task is updated | Tasks |
*See Webhooks > Overview for more details.