Custom Action Health Monitoring¶

Open Chat Studio regularly checks whether each Custom Action is available so you can see whether the connection is working.

How Custom Action health checks work¶

Automatic checks run once every hour. They cover only Custom Actions that a chatbot can call: the action must be used in the pipeline of at least one chatbot that is not archived. In the chatbot's working version, at least one of the operations selected on the node must still be allowed on the Custom Action. Custom Actions used only by archived chatbots, or not used at all, are not checked automatically.

If a check finds that a previously working Custom Action has gone down, a notification is sent to team members who can manage Custom Actions.

Viewing health status¶

You can view the health status of your Custom Actions in two places in the Developers section of Team Settings:

1. Custom Actions table: The list of Custom Actions gives you a quick view of which services are available, along with a status indicator.
2. Custom Action page: When you open a Custom Action for your team, you can check its status while updating the configuration.

Manual health checks¶

In addition to automatic monitoring, you can manually trigger a health check at any time. This is useful when:

• you have just configured a new Custom Action and want to verify connectivity immediately
• you have made changes to your external service and want to confirm that it is still reachable
• the automatic check shows that a service is down and you want to verify that it is back online

When you run a manual check, the result appears right away. A check also runs when you create a Custom Action. Manual checks and checks on creation run for any Custom Action, including unused ones, and record the resulting status. The team is notified only when the status changes to Down for a Custom Action that a chatbot can call.

Health status values¶

A Custom Action can report one of the following states:

• Up: the external service is reachable and responds successfully to the health check
• Down: the external service could not be reached or returned an error
• Unknown: no health check has completed yet. This can occur when:
  • the health check endpoint has not been configured for the Custom Action
  • the Custom Action was recently created and the automatic health check task has not yet run

For a Custom Action that no chatbot uses, the status shown is the result of the last check that ran, which may be out of date. Run a manual check to refresh it.

See also¶

• Notifications — how health check failures and other issues are surfaced to your team
• Failure notifications — alerts for Custom Action calls that fail during a conversation