With subscribe actions, you’ll receive near-instant webhooks as events occur in your customers’ SaaS applications. This enables your application to quickly react to events such as record creation, deletion, and field updates.
Subscribe actions are in beta.
To subscribe to an object in Salesforce, you currently need to also have a read action specified for the object. In addition, you need to specify:
true
to inherit the mapped and unmapped fields from the Read Action. Learn more in Fields and mapping.You then need to specify the particular events you want to subscribe to. We support the following events:
createEvent: triggers when a new record is created in the SaaS application.
updateEvent: triggers when any existing record is modified. The watchFieldsAuto: all
setting ensures that you subscribe to all field changes. Alternatively, you can list specific fields to watch in requiredWatchFields
. Note: Only one of requiredWatchFields
or watchFieldsAuto
should be provided.
deleteEvent: triggers when a record is removed from the system.
If you do not already have a Salesforce integration, follow the instructions in the Salesforce provider guide to get started.
You can provide fields to watch for update events and specify them in a list.
Note: Only one of requiredWatchFields
or watchFieldsAuto
should be provided.
Here is an example amp.yaml
For an example of a webhook message delivered according to the above amp.yaml
, please see Subscribe action webhooks.
By combining subscribe actions with read actions, you can get a full picture of all the data in your customer’s SaaS instance. You can:
Here is an example amp.yaml
:
If you do not wish to do a backfill when the integration is first installed, you can omit the backfill block in the read action definition. Because there aren’t any schedules or backfills defined, the read action won’t actually do anything but its fields and mappings will be used by the subscribe action.
HubSpot subscribe actions cannot notify you of changes to custom fields. There is a workaround that requires additional set up, please contact support@withampersand.com for details.
To enable HubSpot subscribe actions, you will need to:
If you do not yet have a HubSpot app, follow the instructions in the HubSpot provider guide to create one. Here are the steps to modify the HubSpot app to enable subscribe actions:
PROJECT_ID
with your Ampersand project ID, which can be found in the Dashboard’s General Settings page.INTEGRATION_ID
with your integration’s ID, which can be found in the Dashboard’s Home page.Your read action’s set of fields and field mappings will apply to the subscribe action. When we deliver you the webhook, it will contain fields
and mappedFields
based on the fields and mapped fields from your read action. You can learn more in Object and field mapping.
You will receive webhook messages about events happening in your customer’s SaaS instance. These webhooks look very similar to the webhooks for read actions. See Subscribe action webhooks for more information.
With subscribe actions, you’ll receive near-instant webhooks as events occur in your customers’ SaaS applications. This enables your application to quickly react to events such as record creation, deletion, and field updates.
Subscribe actions are in beta.
To subscribe to an object in Salesforce, you currently need to also have a read action specified for the object. In addition, you need to specify:
true
to inherit the mapped and unmapped fields from the Read Action. Learn more in Fields and mapping.You then need to specify the particular events you want to subscribe to. We support the following events:
createEvent: triggers when a new record is created in the SaaS application.
updateEvent: triggers when any existing record is modified. The watchFieldsAuto: all
setting ensures that you subscribe to all field changes. Alternatively, you can list specific fields to watch in requiredWatchFields
. Note: Only one of requiredWatchFields
or watchFieldsAuto
should be provided.
deleteEvent: triggers when a record is removed from the system.
If you do not already have a Salesforce integration, follow the instructions in the Salesforce provider guide to get started.
You can provide fields to watch for update events and specify them in a list.
Note: Only one of requiredWatchFields
or watchFieldsAuto
should be provided.
Here is an example amp.yaml
For an example of a webhook message delivered according to the above amp.yaml
, please see Subscribe action webhooks.
By combining subscribe actions with read actions, you can get a full picture of all the data in your customer’s SaaS instance. You can:
Here is an example amp.yaml
:
If you do not wish to do a backfill when the integration is first installed, you can omit the backfill block in the read action definition. Because there aren’t any schedules or backfills defined, the read action won’t actually do anything but its fields and mappings will be used by the subscribe action.
HubSpot subscribe actions cannot notify you of changes to custom fields. There is a workaround that requires additional set up, please contact support@withampersand.com for details.
To enable HubSpot subscribe actions, you will need to:
If you do not yet have a HubSpot app, follow the instructions in the HubSpot provider guide to create one. Here are the steps to modify the HubSpot app to enable subscribe actions:
PROJECT_ID
with your Ampersand project ID, which can be found in the Dashboard’s General Settings page.INTEGRATION_ID
with your integration’s ID, which can be found in the Dashboard’s Home page.Your read action’s set of fields and field mappings will apply to the subscribe action. When we deliver you the webhook, it will contain fields
and mappedFields
based on the fields and mapped fields from your read action. You can learn more in Object and field mapping.
You will receive webhook messages about events happening in your customer’s SaaS instance. These webhooks look very similar to the webhooks for read actions. See Subscribe action webhooks for more information.