Webhook Table (505)
Some tooltip text!
• 2 minutes to read
• 2 minutes to read
Webhook URL to call when events occur in the client or in NetServer. Also tracks call+error statistics.
Fields
| Name | Description | Type | Null |
|---|---|---|---|
| webhook_id | Primary key | PK | |
| name | Name to identify this webhook. Does not have to be unique. | String(400) | |
| events | Comma separated list of event names that this hook responds to: 'contact.created,person.changed,project.deleted' | String(4000) | |
| target_url | Destination to POST event info to. URL for webhooks. Id for CRM scripts | String(4000) | |
| type | Name of plugin that handles this webhook. 'webhook' for webhooks, which are handled by the system plugin. | String(100) | |
| application_token | Application that registered this hook. If set, then other apps won't be able to modify this record | String(200) | ● |
| headers | Hook specific additional HTTP headers that should be added to HTTP request, stored as JSON blob | Clob | ● |
| properties | Hook specific additional data that should be added to payload, stored as JSON blob | Clob | ● |
| secret | Shared secret key used for generating SHA256 HMAC signature, so that receiver can verify that call came from this server | String(400) | ● |
| state | Webhook status - should we post events to the URL? 1=Active, 2=Stopped or 3=TooManyErrors | Enum WebhookState | |
| registered | Registered when | UtcDateTime | |
| registered_associate_id | Registered by whom | FK associate | |
| updated | Last updated when | UtcDateTime | |
| updated_associate_id | Last updated by whom | FK associate | |
| updatedCount | Number of updates made to this record | UShort |
Indexes
| Fields | Types | Description |
|---|---|---|
| webhook_id | PK | Clustered, Unique |
Relationships
| Table | Description |
|---|---|
| associate | Employees, resources and other users - except for External persons |
Replication Flags
- None
Security Flags
- No access control via user's Role.