Webhook Table (523)
Webhook URL to call when events occur in the client or in NetServer. Also tracks call+error statistics.Fields
| Name | Description | Type | Nullable |
|---|---|---|---|
| webhook_id | Primary key | PK | No |
| name | Name to identify this webhook. Does not have to be unique. | String(400) | No |
| events | Comma separated list of event names that this hook responds to: βcontact.created,person.changed,project.deletedβ | String(4000) | No |
| target_url | Destination to POST event info to. URL for webhooks. Id for CRM scripts | String(4000) | No |
| type | Name of plugin that handles this webhook. βwebhookβ for HTTP POST notifications, βcrmscriptβ for script invocations. | String(100) | No |
| application_token | Application that registered this hook. If set, then other apps wonβt be able to modify this record | String(200) | Yes |
| headers | Hook specific additional HTTP headers that should be added to HTTP request, stored as JSON blob | Clob | Yes |
| properties | Hook specific additional data that should be added to payload, stored as JSON blob | Clob | Yes |
| secret | Shared secret key used for generating SHA256 HMAC signature, so that receiver can verify that call came from this server | String(400) | Yes |
| state | Webhook status - should we post events to the URL? 1=Active, 2=Stopped or 3=TooManyErrors | Enum WebhookState | No |
| registered | Registered when | UtcDateTime | No |
| registered_associate_id | Registered by whom | FK associate | No |
| updated | Last updated when | UtcDateTime | No |
| updated_associate_id | Last updated by whom | FK associate | No |
| updatedCount | Number of updates made to this record | UShort | No |
| errors_email | Email address to send error message to when this webhook state changes to too-many errors. | String(239) | Yes |
| description | Human-readable description of what this webhook does. | String(4000) | Yes |
| notify_via | How to notify recipients when this webhook changes state. 1=Email, 2=InApp. | Enum WebhookNotifyVia | No |
| notify_when | When to notify recipients. Bitflag: 1=FirstFailure, 2=Disabling. | Enum WebhookNotifyWhen | No |
Indexes
| Fields | Types | Description |
|---|
Relationships
| Table | Description |
|---|---|
| associate | Employees, resources and other users - except for External persons |
| Webhook_notify | Notification recipients for webhook failure events. Each row defines one recipient (associate or ad-hoc email) that should be notified when a webhook fails. |
Replication Flags
- None
Security Flags
- No access control via userβs Role.