What is this feature for?
This feature enables teams with internal developer resources to trigger Meta rule checks programmatically by making calls to the Bïrch API. For instance, if your rules use custom data from Google Sheets, you may want to initiate rule checks precisely when the Sheets are updated with fresh data.
ℹ️ This functionality is available upon request for Enterprise clients only. Please reach out to the team on the website by clicking a chat bubble in the bottom right corner or at support@bir.ch 💬
How to run rule checks via API
Follow the steps below to connect to Bïrch API and manage your rule checks programmatically:
Request this feature
Reach out to your account manager or Bïrch support team at support@bir.ch or via chat on the website to request access to the feature.
Enable the option in rule settings
Once you have received access confirmation from the team, you will need to enable this option inside each rule that you want to use in this mode.
Open the rule, navigate to "Schedule", and select the option "Run via API call":
Under this option, you will see Rule ID and link to our API Documentation. You will need to pass this information to your developer.
Get your Bïrch API access token
Navigate to the Settings of your account and copy the API access token:
Pass the information to your developer
Provide your developer with the list of Rule IDs that have this option enabled along with the API access token and link to the API Documentation. Using this data, your team member will be able to set up the system to run checks via API based on your team needs.