Skip to content

List of webhook event types

The webhook event types used in Truto. These values can be found in the event attribute of a webhook event.

Subscribe a webhook to all to receive every event type listed below.

Integrated accounts

  • integrated_account:created - A new integrated account is connected
  • integrated_account:updated - Integrated account is updated
  • integrated_account:deleted - Integrated account is deleted
  • integrated_account:post_install_error - Post install steps failed after an integrated account got connected. The integrated account will need re-authorization.
  • integrated_account:validation_error - If defined for the Installed integration, Connection validation steps defined for the integrated account failed. The integrated account will need re-authorization.
  • integrated_account:active - Integrated account is activated and ready to use
  • integrated_account:post_connect_form_submitted - If defined for the Installed integration, RapidForm has been submitted by the user.
  • integrated_account:authentication_error - Sent when there is an issue with refreshing the access token in case of OAuth authentication or the credentials are no longer valid for other authentication methods for an integrated account.
  • integrated_account:reactivated - This event is sent when an integrated account is moved to active state after it is in needs_reauth state. Important: This event will NOT be sent if you are reauthenticating the integrated account, it will only be sent if Truto detects that the integrated account didn't error out with 401 status code when calling the underlying integration's API, this can happen when proxy and unified APIs are called, or when Sync Jobs are run. This event is provided to handle transient authentication errors if any.
  • integrated_account:forbidden_error - A call made with the integrated account got a 403 from the underlying integration, for example because the connection is missing a required scope. The account stays active.
  • link_token:connection_error - A connection attempt started from a link token failed before an integrated account was created, for example an OAuth authorization error.

Installed integrations

  • environment_integration:created - An integration is installed in the environment
  • environment_integration:updated - An installed integration is updated
  • environment_integration:deleted - An installed integration is removed from the environment

Environment unified models

  • environment_unified_model:created - A unified model is added to the environment
  • environment_unified_model:updated - A unified model in the environment is updated
  • environment_unified_model:deleted - A unified model is removed from the environment

API tokens

  • api_token:created - An API token is created
  • api_token:updated - An API token is updated
  • api_token:deleted - An API token is deleted

Sync Job Run

  • sync_job_run:created - A new sync job run is created
  • sync_job_run:started - Sync job run has started
  • sync_job_run:record - Webhook containing the records fetched from a resource during the sync job run
  • sync_job_run:completed - Sync job run has completed
  • sync_job_run:failed - Sync job run has failed
  • sync_job_run:updated - Sync job run has been updated
  • sync_job_run:deleted - Sync job run has been deleted
  • sync_job_run:record_error - Fetching records from a resource failed during the sync job run
  • sync_job_run:rate_limited - The underlying integration rate limited a request during the sync job run

Sync job cron triggers

  • sync_job_cron_trigger:failed - A sync job cron trigger could not start a new sync job run because the previous run has not completed yet

Records

Sent when webhooks have been setup for the underlying Integration.

  • record:created - A new record is created in the underlying integration.
  • record:updated - Record is updated in the underlying integration.
  • record:deleted - Record is deleted in the underlying integration.
  • record:meta - The underlying integration sent a non-record event, such as a subscription lifecycle notification. records is empty.

Batch jobs

  • batch_job:dry_run_completed - A batch job dry run has completed
  • batch_job:completed - A batch job has completed
  • batch_job:dry_run_failed - A batch job dry run has failed
  • batch_job:failed - A batch job has failed