Create webhooks
Alex Bitca avatar
Written by Alex Bitca
Updated over a week ago

You can create webhooks manually on the Inbound Webhooks page or they can be created automatically from within a transactional email campaign.

Create manually

On the Inbound Webhooks page click the + Create new webhook button. A popup will ask you to fill in the following details:

  • Webhook name: Give your webhook a clear name so that it's easy to understand what it will be used for (e.g., Import contacts from Salesforce, Send survey when Zendesk ticket is closed, etc).

  • Scope: The scope defines what the webhook is able to do. For example, a webhook link may have the ability to import contacts and survey them in a particular email campaign, while other webhook links may only be able to import contacts and can't trigger any surveys. There are three scopes that you can choose from:

    • Send transactional survey: Creates/updates contact and send survey if the webhook is assigned to a campaign.

    • Create or update contact: Only creates/updates contact and cannot trigger a survey since this webhook cannot be assigned to a campaign.

    • Unsubscribe contact: Marks an existing contact as unsubscribed so that they can no longer receive surveys. Doesn't create new contacts, but upon unsubscribing will update the contact with the data sent via the webhook.

  • Integration: Choose the name of the service where you will configure the Retently webhook, and every time a specific event will be triggered in that service, the webhook will receive the event and will perform an action in Retently (based on the webhook's scope).

Once the webhook is created, you will find it on the Inbound Webhooks page, where you can copy it and further use it in the service that you've selected as the webhook's scope.

Create automatically

Webhooks may be created automatically in an email transactional survey campaign.

Note: Webhooks that are created automatically will have a "Send survey" scope.

To have the webhook created automatically, access the campaign in edit mode, go to the Trigger section, and in the "Survey triggered via" menu, choose the service where you will configure the Retently webhook.

Once the service is selected, a webhook will be created automatically if any of these conditions are met:

  • You don't have a valid webhook which is an active (switched ON) webhook for this service on the Inbound Webhooks page yet.

  • You may have a valid webhook, but it's already assigned to another survey campaign (note: a webhook can be assigned only to one campaign, and a campaign can have only one webhook assigned).

Otherwise, if you have one or more valid webhooks, then you will be asked to select one from your list.

The webhook created automatically will have the following details:

  • Webhook name: Will be generated automatically with the name of the service and the scope of the webhook (e.g., Salesforce: Send transactional email surveys).

  • Integration: Will be set as the name of the service that you've selected.

  • Scopre: Will be set as "Send transactional email surveys".

The webhooks created automatically will also be available on the Inbound Webhooks page.

Did this answer your question?