Sign in
Events

List events

List events

get/events

Query parameters

partyIdstring

Defaults to your party. To act for another party, pass the ID of a party that has authorized you to act on its behalf.

eventType'party.updated' | 'compliance_case.updated' | 'wallet.created' | 'external_account.connected' | 'agent_delegation_invitation.created' | 'agent_delegation_invitation.accepted' | 'agent_delegation_invitation.declined' | 'agent_delegation_invitation.canceled' | 'agent_delegation.revoked' | 'delegation.activated' | 'delegation.revoked' | 'invitation_link.created' | 'invitation_link.revoked' | 'invitation_link.agent_added' | 'invitation_link.agent_removed' | 'invitation_link.redeemed' | 'deposit.created' | 'deposit.completed' | 'deposit.failed' | 'deposit.returned' | 'deposit.canceled' | 'deposit.approval_denied' | 'withdrawal.created' | 'withdrawal.completed' | 'withdrawal.failed' | 'withdrawal.returned' | 'withdrawal.canceled' | 'withdrawal.approval_denied' | 'payment.created' | 'payment.completed' | 'payment.failed' | 'payment.returned' | 'payment.canceled' | 'payment.approval_denied' | 'ach.created' | 'ach.processing' | 'ach.settled' | 'ach.failed' | 'ach.returned' | 'external_party_account.validated' | 'approval.required' | 'approval.approved' | 'approval.denied' | 'approval.canceled' | 'payment_request.created' | 'payment_request.completed' | 'payment_request.canceled' | 'payment_request.declined' | 'payment_request.incoming' | 'mandate.created' | 'mandate.revoked'

Filter by event type. Required when partyId names another party.

createdAfterstring date-time

Return events created after this timestamp.

createdBeforestring date-time

Return events created before this timestamp.

cursorstring

Cursor from the previous page.

limitinteger

Maximum results per page.

Headers

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Response

Successful Response

Changes

Changed in 6 of the 28 revisions of this API.11717

  • 359d267dca881See the full diff
    • ○

      deleted the header request parameter X-Agent-ID with deprecation

      request-parameter-removed-with-deprecation

  • b1ad79e918ac1See the full diff
    • ○

      header request parameter X-Agent-ID was deprecated

      request-parameter-deprecated

  • a77f94c2883a112See the full diff
    • ▲

      removed the enum value ach.completed from the query request parameter eventType

      request-parameter-enum-value-removed

    • ●

      added the new ach.settled enum value to the data/items/attributes/eventType response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new enum value ach.settled to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      removed the ach.completed enum value from the data/items/attributes/eventType response property for the response status 200

      response-property-enum-value-removed

  • c309952835b588See the full diff
    • ●

      added the new ach.completed enum value to the data/items/attributes/eventType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ach.created enum value to the data/items/attributes/eventType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ach.failed enum value to the data/items/attributes/eventType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ach.processing enum value to the data/items/attributes/eventType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ach.returned enum value to the data/items/attributes/eventType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new external_party_account.validated enum value to the data/items/attributes/eventType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new mandate.created enum value to the data/items/attributes/eventType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new mandate.revoked enum value to the data/items/attributes/eventType response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new enum value ach.completed to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value ach.created to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value ach.failed to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value ach.processing to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value ach.returned to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value external_party_account.validated to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value mandate.created to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value mandate.revoked to the query request parameter eventType

      request-parameter-enum-value-added

  • 68aaf2076cfc55See the full diff
    • ●

      added the new invitation_link.agent_added enum value to the data/items/attributes/eventType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new invitation_link.agent_removed enum value to the data/items/attributes/eventType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new invitation_link.created enum value to the data/items/attributes/eventType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new invitation_link.redeemed enum value to the data/items/attributes/eventType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new invitation_link.revoked enum value to the data/items/attributes/eventType response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new enum value invitation_link.agent_added to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value invitation_link.agent_removed to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value invitation_link.created to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value invitation_link.redeemed to the query request parameter eventType

      request-parameter-enum-value-added

    • ○

      added the new enum value invitation_link.revoked to the query request parameter eventType

      request-parameter-enum-value-added

  • 270e233e401c3See the full diff
    • ●

      for the query request parameter createdAfter, the maxLength was set to 64

      request-parameter-max-length-set

    • ●

      for the query request parameter createdBefore, the maxLength was set to 64

      request-parameter-max-length-set

    • ●

      for the query request parameter cursor, the maxLength was set to 1024

      request-parameter-max-length-set