Skip to main content
Version: Current

webhooks

  • ListWebhooksOptions​

    Defines an interface that represents the options for a list data action.

    Members​

    • endpoint? string​

      The HTTP endpoint that the request should interface with.

    • sort? ("ascending" | "descending")​

      The order that items should be sorted in.

      • "ascending" means that the items should be sorted in alphebatically ascending order by address.
      • "descending" means that the items should be sorted in alphebatically descending order by address.

  • WebhookRecord​

    Defines a record that represents a webhook.

    Members​

    • address string​

      The address of the record.

    • markers string[]​

      The markers that are associated with the record.

    • targetAddress string​

      The address of the record that is being targeted by this webhook.

    • targetRecordName string​

      The name of the record that is being targeted by this webhook. Null if the webhook is targeting a public inst.

    • targetResourceKind ("inst" | "data" | "file")​

      The resource kind of the webhook target.

      • 'file': The webhook target is a file record.
      • 'inst': The webhook target is an instance record.
      • 'data': The webhook target is a data record.

    • userId? string​

      The ID of the user that represents the webhook. This is used to authenticate the webhook for access to resources.

      If null, then the webhook does not use any authentication.