> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhook table

> Webhook URL to call when events occur in the client or in NetServer. Also tracks call+error statistics.

## 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](./enums/webhookstate.mdx)           |    No    |
| registered                | Registered when                                                                                                          | UtcDateTime                                             |    No    |
| registered\_associate\_id | Registered by whom                                                                                                       | FK [associate](./associate.mdx)                         |    No    |
| updated                   | Last updated when                                                                                                        | UtcDateTime                                             |    No    |
| updated\_associate\_id    | Last updated by whom                                                                                                     | FK [associate](./associate.mdx)                         |    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](./enums/webhooknotifyvia.mdx)   |    No    |
| notify\_when              | When to notify recipients. Bitflag: 1=FirstFailure, 2=Disabling.                                                         | Enum [WebhookNotifyWhen](./enums/webhooknotifywhen.mdx) |    No    |

<img src="https://mintcdn.com/superofficeas/i6M2qZmvMNH7UTeu/media/loc/en/database/tables/Webhook.png?fit=max&auto=format&n=i6M2qZmvMNH7UTeu&q=85&s=88c89a7a78ec7ab005a60f7610992469" alt="Webhook table relationship diagram" width="701" height="59" data-path="media/loc/en/database/tables/Webhook.png" />

## Indexes

| Fields | Types | Description |
| ------ | ----- | ----------- |

## Relationships

| Table                               | Description                                                                                                                                                  |
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [associate](./associate)            | Employees, resources and other users - except for External persons                                                                                           |
| [Webhook\_notify](./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.


## Related topics

- [Webhook](/en/api/archive-providers/reference/webhook.md)
- [What's new in version 12.0.342.0](/release-notes/database/changes-12.0.342.md)
- [What's new in version 12.1.1412.0](/release-notes/database/changes-12.1.1412.md)
- [What's new in version 12.2.2072.0](/release-notes/database/changes-12.2.2072.md)
- [What's new in version 12.3.2195.0](/release-notes/database/changelog.md)
- [What's new in version 11.1.447.0](/release-notes/database/changes-11.1.447.md)
