Webhook subscription
This table is used to set up from which table and company webhook events will be received.
| Property | Value | Description |
|---|---|---|
| Database | System | This table is in the system (vbsys) database. |
| SQL name | WhSsc | The table name in the database. |
| API identifier | webhookSubscription | The API identifier used in GraphQL. |
| Table no. | 461 | The table number in the data model. |
The following fields exist in this table:
Company no.
Company no. for the table that will receive webhook events.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | Company no. | Integer |
| Primary key | Yes | Company no., Table no., Webhook target |
| SQL name | FrmNo | The database field name. |
| API identifier | companyNo | The API identifier used in GraphQL. |
| Number | 19746 |
| To table | Purpose | From columns | To columns | Comments |
|---|---|---|---|---|
| Company | WebhookSubscriptionCompany |
|
Filter out
Selection of webhook events to exclude from webhook messages.
- Insert
- Checking this option excludes events of the INSERT event type.
Bit value = 1
- Update
- Checking this option excludes events of the UPDATE event type.
Bit value = 2
- Delete
- Checking this option excludes events of the DELETE event type.
Bit value = 4
- User
- This can be called a “feedback” filter, because it filters messages
that the given user is responsible for. This is useful for integration applications
registered both as GraphQL applications and as webhook applications in Business NXT. Enabling the “feedback” filter allows synchronisation from other applications and
Business NXT updates to be synchronised while filtering out updates that come from the
integration application itself.
Bit value = 8
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | Filter out | Integer |
| SQL name | Fltr | The database field name. |
| API identifier | filter | The API identifier used in GraphQL. |
| Number | 20645 |
JQ filter
An optional filter expression that controls which table-change events are actually delivered to a webhook.
It lets you subscribe to a table but only receive the subset of changes you care about, instead of every change on that table.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | Text | Unlimited text |
| SQL name | JqFltr | The database field name. |
| API identifier | jqFilter | The API identifier used in GraphQL. |
| Number | 21759 |
Table no.
Table number for the table that will receive webhook events.
You can select a table by looking up in this field.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | Table no. | Integer |
| Primary key | Yes | Company no., Table no., Webhook target |
| SQL name | TblNo | The database field name. |
| API identifier | tableNo | The API identifier used in GraphQL. |
| Number | 19747 |
Webhook target
The target webhook events are sent to.
| Property | Value | Description |
|---|---|---|
| Visible by default | Yes | This field is visible by default in the table display. |
| Domain | No. | Integer |
| Primary key | Yes | Company no., Table no., Webhook target |
| SQL name | Tgt | The database field name. |
| API identifier | target | The API identifier used in GraphQL. |
| Number | 19748 |
| To table | Purpose | From columns | To columns | Comments |
|---|---|---|---|---|
| Webhook target | WebhookSubscriptionTarget |
|
Control columns
Control columns include information about who has changed the record last and when, and which process that is currently editing the record.
Changed by provenance
The provenance for the record change.
A look-up in this field gives you the following list of possible values:
0 - None
1 - UI
10 - External API
20 - GAiA
21 - AI Connect
100 - Internal service
101 - Task automation
102 - AutoInvoice download
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | Provenance | Integer |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | ChPvn | The database field name. |
| API identifier | changedByProvenance | The API identifier used in GraphQL. |
| Number | A unique column number. |
Changed by user
The name of the user that changed the record.
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | User name | Text (24) |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | ChUsr | The database field name. |
| API identifier | changedByUser | The API identifier used in GraphQL. |
| Number | A unique column number. |
Changed date
The date when the record was changed.
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | Date | Integer |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | ChDt | The database field name. |
| API identifier | changedDate | The API identifier used in GraphQL. |
| Number | A unique column number. |
Changed time
The time when the record was changed.
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | Time | Integer |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | ChTm | The database field name. |
| API identifier | changedTime | The API identifier used in GraphQL. |
| Number | A unique column number. |
Changed time stamp
The date and time when the record was changed.
The field is updated with the UTC time.
This value can be used by external systems to replicate changed data. The column is indexed.
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | Date/time | DateTime |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | ChTs | The database field name. |
| API identifier | changedTimestamp | The API identifier used in GraphQL. |
| Number | A unique column number. |
Created by provenance
The provenance for the record creation.
A look-up in this field gives you the following list of possible values:
0 - None
1 - UI
10 - External API
20 - GAiA
21 - AI Connect
100 - Internal service
101 - Task automation
102 - AutoInvoice download
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | Provenance | Integer |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | CrePvn | The database field name. |
| API identifier | createdByProvenance | The API identifier used in GraphQL. |
| Number | A unique column number. |
Created by user
The name of the user that created the record.
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | User name | Text (24) |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | CreUsr | The database field name. |
| API identifier | createdByUser | The API identifier used in GraphQL. |
| Number | A unique column number. |
Created date
The date when the record was created.
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | Date | Integer |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | CreDt | The database field name. |
| API identifier | createdDate | The API identifier used in GraphQL. |
| Number | A unique column number. |
Created time
The time when the record was created.
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | Time | Integer |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | CreTm | The database field name. |
| API identifier | createdTime | The API identifier used in GraphQL. |
| Number | A unique column number. |
Created time stamp
The date and time when the record was created.
The field is updated with the UTC time.
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | Date/time | DateTime |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | CreTs | The database field name. |
| API identifier | createdTimestamp | The API identifier used in GraphQL. |
| Number | A unique column number. |
Edit status
The current status of the record.
A look-up in this field gives you the following list of possible values:
0 - Unchanged: The record is read, but not changed.
1 - Inserted: The record is new.
2 - Changed: The record is changed.
3 - Deleted: The record is deleted.
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | Edit status | Integer |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | LckSt | The database field name. |
| API identifier | editStatus | The API identifier used in GraphQL. |
| Number | A unique column number. |
Process no
The Process no. from the Active company process table which is currently using or has control of this record.
| Property | Value | Description |
|---|---|---|
| Visible by default | No | This field is not visible by default in the table display. |
| Domain | Process no. | Integer |
| Write Access | None | You are not allowed to modify the value in this field. |
| SQL name | ChPrc | The database field name. |
| API identifier | lockedByProcessNo | The API identifier used in GraphQL. |
| Number | A unique column number. |
| To table | Purpose | From columns | To columns | Comments |
|---|---|---|---|---|
| Active company process | CompanyProcess | Process no. | Process no. |