Skip to content

Latest commit

 

History

History
19 lines (15 loc) · 1.73 KB

File metadata and controls

19 lines (15 loc) · 1.73 KB

invoicetronicSdk.WebHook

Properties

Name Type Description Notes
id Number Unique identifier. For POST requests, leave it at `0` — the server will assign one automatically. For PUT requests, set it to the id of the record you want to update. [optional]
created Date Creation date. It is set automatically. [optional] [readonly]
version Number Row version, for optimistic concurrency. It is set automatically. [optional] [readonly]
userId Number User id. It is set automatically based on the authenticated user. [optional] [readonly]
companyId Number Optional company id. If set, the webhook is restricted to events for that company; if omitted, it fires for all companies on the account. [optional]
url String The url of your application's endpoint that will receive a POST request when the webhook is fired.
enabled Boolean Whether the webhook is enabled. On creation, this is set to `true`. [optional]
secret String The secret used to generate webhook signatures, only returned on creation. You should store this value securely and validate it on every call, to ensure that the caller is InvoicetronicApi. [optional]
description String An optional description. [optional]
events [String] List of events that trigger the webhook. See Invoicetronic.SupportedEvents.Available for a list of valid event names. [optional]
failureNotifiedAt Date Timestamp of the last failure notification email sent for this webhook. Set by the notifier service; reset to null on successful delivery. [optional] [readonly]