PUT /events/{eventType}/rules

Updates rules associated with a specified event type.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
_links[] Array No

Related links.

_links[].href String No

Link URL.

_links[].rel String No

Type of link.

Valid values:

  • "self"
rules[] Array Yes

Rules can be configured to stop subsequent rules in the event list from being executed. A rule is a configuration of an event and one or more actions.

updatedTime String No

Date and time when the resource is updated. This value is set automatically when the resource is updated.

createdTime String No

Date and time when the resource is created. This value is set automatically when the resource is created.

version Integer No

Version of the ruleset.

binds[] Array No

Binds always execute, regardless of rule based events. A bind is a configuration of an event and one or more actions.

binds[].id String No

ID of the rule.

binds[].actions[] Array Yes

Actions that execute when an event occurs.

binds[].actions[].name String Yes

Name of the action.

Valid values:

  • "reset-reminder"
  • "trigger-webhook"
  • "adjust-ready-to-pay"
  • "abandon-scheduled-payments"
  • "create-intuit-quickbooks-refund-receipt"
  • "remove-reminder"
  • "schedule-reminder"
  • "void-intuit-quickbooks-invoice"
  • "perform-experian-check"
  • "schedule-invoice-retry"
  • "guess-payment-card-expiration"
  • "tag-or-untag-customer"
  • "update-intuit-quickbooks-invoice"
  • "send-email"
  • "stop-subscriptions"
  • "adjust-ready-to-payout"
  • "create-intuit-quickbooks-revenue-recognition-entry"
  • "pick-gateway-account"
  • "check-ontario-restriction"
  • "decline-transaction"
  • "create-intuit-quickbooks-invoice"
  • "schedule-payment"
  • "create-intuit-quickbooks-balance-transaction-entry"
  • "blocklist"
  • "cancel-scheduled-payments"
  • "show-descriptor-disclaimer"
  • "display-other-choices"
  • "add-risk-score"
  • "request-kyc"
  • "create-intuit-quickbooks-payment"
binds[].actions[].status String No

Status of the action.

Valid values:

  • "inactive"
  • "active"

Default value: "active"

binds[].name String Yes

Name of the rule.

binds[].labels[] Array No

Labels of the rule.

binds[].filter String No

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

binds[].status String No

Status of the rule.

Valid values:

  • "inactive"
  • "active"

Default value: "active"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.