optionalFieldsAuto: all
. The UI component will populate a list of all the fields pulled from that object (including custom fields) and allow them to pick which ones your app will be able to read.
backfill
key in the integration definition, or you can write 0 days as the default period.
fullHistory
to true. If you have customers that have large SaaS instances, please ensure that your webhook endpoint can handle a high number of messages in quick succession. You may find it helpful to use a webhook gateway solution like Hookdeck.
schedule
field in the amp.yaml
), or you can exclusively use the trigger read API without defining a schedule.
There are 2 types of reads that can be triggered:
auto
, Ampersand will automatically send results to your destination as it reads new data from the SaaS instance.
onRequest
, Ampersand will not send webhooks as it reads new data, but only when you request for more results. This is useful when you want to control the rate at which you receive data. For precise control over how much data you receive each time, you can configure the page size, which specifies the number of records to send in each webhook payload.
Please note that the page size is a maximum, and the actual number of records in each payload may be less if there are fewer records available in the SaaS instance. Currently, may configure a page size between 50 and 500. Please reach out to us if you need this to be lower or higher.
Here’s an example of how to configure the delivery mode to onRequest
for a Salesforce Contact object, with a max page size of 50 records per webhook message:
pageSize
of 50 in your amp.yaml
, you should request 6 pages (300 divided by 50).