WebhookHistoryTableStorageModel

Represents the Webhook Trigger History

Methods

The following API methods use this data model.

Required Fields

groupKey

uuid

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.

webhookId

uuid

The WebhookId uniquely identifies the webhook used to send notification that an event action has taken place.

webhookHistoryId

uuid

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

requestSent

boolean

Flag whether request was sent to callback url successfully or blocked by failing or because it was disabled.

isSuccessful

boolean

Flag whether webhook notification was successful overall (if webhook disabled should always return true otherwise
depends on the response from the callback url)

failureCount

int32

Number of times message failed to be sent over to callback url before succeeding or failing out.
The maximum value should is based on webhook.

Optional Fields

eventType

string, nullable

Event type which fired webhook

[entity].[action]

responseStatusCode

string, nullable

Response status code that is returned when calling a callback url.

processResultMessage

string, nullable

Message containing information about the webhook callback results

timestamp

date-time, nullable

Timestamp of when a request is sent to a webhook callback.
Contains the last time message is sent if failures occur.

records

string, nullable

The records sent with the webhook.

requestMessage

string, nullable

The request message sent with the webhook.

responseMessage

string, nullable

The response received back from the webhook.


Did this page help you?