WebhookRuleModel

A Webhook Rule is a subscription to receive notifications whenever a specific event occurs.

With the rule, you specify the Table and event you want to subscribe to.
You can also optionally specify a filter to further refine the updates you want to receive.

Methods

The following API methods use this data model.

Read-Only Fields

These fields are assigned by the API server and cannot be changed.

webhookRuleId

uuid, read-only

The unique ID of this record, automatically assigned by Lockstep when this record is
added to the Lockstep platform.

groupKey

uuid, read-only

The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
account will share the same GroupKey value. GroupKey values cannot be changed once created.

For more information, see Accounts and GroupKeys.

created

date-time, read-only

The date this webhook rule was created

createdUserId

uuid, read-only

The ID of the user who created this webhook rule

modified

date-time, read-only

The date this webhook rule was last modified

modifiedUserId

uuid, read-only

The ID of the user who last modified this webhook rule

Required Fields

webhookId

uuid

The unique Webhook ID that will be used to fire the webhook for this rule.

tableKey

string, 0-40 characters

A Webhook rule is setup to be fired based on TableKey and EventType.
For example, a Webhook setup for when an Invoice is Created would have a TableKey value of
Invoice and an EventType value of I (Insert).

The TableKey value contains the name of the table within the Lockstep Platform to which this metadata
is connected.

For more information, see linking metadata to an object.

eventType

string, 0-1 characters

A Webhook rule is setup to be fired based on TableKey and EventType.
For example, a Webhook setup for when an Invoice is Created would have a TableKey value of
Invoice and an EventType value of I (Insert).

The EventType value is one of the following:

  • I (Insert)
  • D (Delete)
  • U (Update)

For more information, see linking metadata to an object.

Optional Fields

filter

string, nullable

An optional Searchlight filter for this webhook rule. See Searchlight Query Language


Did this page help you?