documentation logo
All you’ll ever need to know about Declarative Webhooks and how to get started.

Pages

Administration Page

About the Admin Page

This Declarative Webhooks Administration tab in the Declarative Webhooks app is a page that provides you with an overview of templates, limits, logs, scheduled jobs and many more settings.

 

Overview

On the left, you’ll find the limits for the current month (test callouts are not included). On the right, the Historical Monthly Usage chart shows data for the past 12 months.

You can also specify an email address to receive notifications when your usage approaches or reaches the limit. After updating the email address, be sure to click Save Changes to apply your update.

 

Callout Templates

This subtab lists all your templates (both active and inactive) along with their name, id, developer name, method, and callout URL.

From here, you can edit existing templates or create a new Callout Template using the + button. You can also quickly activate or deactivate templates by clicking the toggle icon.

 

Inbound Call Templates

This subtab shows all the inbound templates you’ve created, both active and inactive. You can edit templates directly from this screen or create a new Inbound Template using the + button. To quickly activate or deactivate a template, use the toggle switch.

At the top of the page, you can see the status of your Declarative Webhooks Relay Server connection and change the user responsible for running inbound calls.

  • If your org is not connected, you’ll have the option to connect using your username.
  • If your org is already connected, you can renew the connection or switch the running user to your account if a different user is currently set.

 

Callout Sequences

This subtab displays all callout sequences you have created. You can edit your sequence from this screen or create a new sequence using the + button.

 

Logs Settings

The Logs Settings tab controls how call logs and sequence logs are stored, and whether you’re notified when calls fail. When you change a setting, click Save Changes to apply it, or Cancel Changes to discard it.

Delete old call logs

When enabled, a daily job deletes call logs older than the number of days you choose. This keeps your org’s data storage clean and efficient. Select the number of days to keep call logs in Number of days to retain call logs.

Delete old sequence logs

This works the same way as the previous setting, but for Callout Sequence logs. Select the number of days to keep sequence logs in Number of days to retain sequence logs.

Save large logs as attachments

Request and response bodies are stored in long text fields, which are limited to 128 KB. Larger bodies are normally truncated. When this setting is enabled, a body over 128 KB is saved in full as an attachment linked to the log record. The Log View page shows it automatically, so you can still see the complete content.

Failed call email notifications

When enabled, Declarative Webhooks emails you when calls fail. Both outbound callouts and inbound calls are covered. A call counts as failed if:

  • it received a response code outside the 2xx–3xx range (lower than 200, or 400 and above), or
  • one or more of its actions failed.

Calls that were ignored, for example through the ignore criteria or header value, never trigger a notification.

Choose how often to be notified in Send notifications:

  • After each failed call: an email is sent as soon as a call fails. It includes the template, method and URL, response code, whether actions failed, the time of the call, and a link to the call log. Note: if something goes wrong and many calls fail, you may receive a large number of emails. These emails also count toward your org’s daily Salesforce email limits.
  • Daily Summary: one email every day at 8:00 AM listing the calls that failed in the previous 24 hours.
  • Weekly Summary: one email every Monday at 8:00 AM listing the calls that failed in the previous 7 days.

A summary shows the total number of failed calls and details for up to 25 of them, each with a link to its call log. If no calls failed in the period, no email is sent. Summaries are built from Call Log records, so if logs are deleted or modified (for example by the Delete old call logs setting), the summary may not include every failed call.

Enter the address that should receive the notifications in Notifications email address. This field is required. To send them to several people, use a shared mailbox or distribution list.

Scheduled Jobs

You have the option to schedule your calls based on a time of your preference. This can be set up within the Schedule Jobs subtab.

 

The column headers are defined as:

  • Job Name: The Name of your schedule job
  • Callout Template: Displays the template used by the scheduled job
  • Batch Size: Total number of records that will be included in each call of the scheduled job
  • Cron Expression: The scheduled CRON syntax of when your scheduled job will run. A CRON expression is defined as a string of fields separated by white spaces that represents a set of times.
  • Job Fired Count: Total number of times this schedule job has ran
  • Next Run Time: Next future run of the scheduled job

To schedule a callout to run periodically, follow the instructions here.

You can also edit some of the details of the scheduled job by clicking the edit button, except for the cron expression. If you need the job to have a different schedule, remove the job and schedule again.

 

Retry Jobs

This tab is used to monitor the retries that are currently scheduled. When an automatic callout fails, a retry job is scheduled for a later time, depending on the admin’s choice. This list will display the jobs that are scheduled to run in the future. See more details in the Retry Support section.

 

Waiting Callouts

When making calls with the “Invoke Callout” flow actions, the callout might not run right away. Depending on context, number of records / callouts and the governor limits, Declarative Webhooks takes a decision on when to make the actual callouts.

If the algorithm decides it cannot run the callouts in the next couple of minutes, it puts them in a waiting list to be picked up by the backup job. The backup job runs once every hour and picks up these waiting calls.

The list of waiting calls are found in the “Waiting Callouts” subtab.

 

Integration AI Agent

When you first install Declarative Webhooks, the Integration AI Agent, which allows you to use AI features, is disabled by default. This tab allows you o enable it.

If the Integration AI Agent is currently disabled, you’ll see a screen indicating that. In some cases, you may be prompted to authorize your user first. If so, click Self Authorize and follow the authorization steps.

The Integration AI Agent connects to https://ai.omnitoria.io, which requires a Remote Site Setting to be configured in Salesforce. To do this, simply click the button labeled Add https://ai.omnitoria.io to Remote Site Settings. This will automatically create the necessary entry.

Once you’ve added the remote site, you’ll see a confirmation message indicating that the Integration AI Agent is now enabled. At this point, setup is complete and you’re ready to start using Declarative Webhooks with AI integration.