Skip to content

Nexus Webhook

Nexus Webhook is a starting component: it runs the flow every time the Nexus CRM reports an event, for example that a new contact comes in, that a deal changes stage or that a tender is submitted. Each event is one run of the flow.

Nexus signs every notification with a secret. The component checks that signature, so the flow only runs with notifications that really come from your Nexus.

When to use it

  • Welcome every new contact by email.
  • Let the team know in Slack or Teams when a deal is won.
  • Prepare the invoice or the customer onboarding when a deal reaches its last stage.
  • Follow the tenders that are submitted and resolved.

Configuration

Nexus is the one that calls the flow. For the component to check the signature of every notification, create a Nexus Webhook credential with the Signing secret Nexus gives you when you create the webhook. See Credentials.

FieldWhat it does
EventsThe events that start the flow. The rest are ignored. Default: contact.created, deal.created and deal.stage_changed. They must also be ticked in the webhook you create in Nexus.
CredentialOptional, but recommended. The Nexus Webhook credential with the signing secret (Signing secret, the whsec_… Nexus shows only once when the webhook is created). With it, notifications without a signature or with a forged one are rejected. Without a credential, the signature isn’t checked.
Max signature age (s) (advanced)Rejects notifications signed more than this many seconds ago, so nobody can resend an old one. Default: 300. With 0 it isn’t checked.
Skip repeated deliveries (advanced)On by default. Nexus may deliver the same event more than once; this way each event runs the flow only once.
Run on test pings (advanced)Off by default. Nexus’s Send test button sends a test notification (test.ping): it is accepted, but it doesn’t run the flow unless you turn this on.
DataUsed to test the component in the editor: paste a sample event here and run the flow. When the flow runs through its webhook, it is filled with what was received. Leave it empty.

These are the events:

EventWhen it arrives
contact.createdA new contact is created.
contact.updatedSomeone edits a contact by hand in Nexus.
deal.createdA deal is created.
deal.stage_changedA deal changes stage, also when it is won or lost.
deal.wonA deal is won.
deal.lostA deal is lost.
resource.createdA new content resource is published through the API, for example with Nexus Marketing.
tender.submittedA tender is submitted.
tender.resolvedA tender is resolved.

A won or lost deal sends its deal.won or deal.lost and, in addition, a deal.stage_changed. There is no event for every change to a deal: changes to the amount or the title don’t notify.

Set it up in Nexus

  1. Deploy a version of the flow: calls to the webhook run the deployed version. See Versions and publishing.
  2. Open the API Access window, go to the Webhook tab, choose the API Key and copy the address. It looks like this: <NappAI API address>/api/v1/webhook/<flow id>?x-api-key=<API key>. The key goes inside the address because Nexus can’t add headers to its notifications. See API keys.
  3. In Nexus, an administrator (ADMIN role) goes to Administration › Integrations and creates an outbound webhook (New webhook): paste the flow’s address in the webhook URL field, tick in Notify when the same events as in Events and click Create webhook.
  4. Nexus shows the Signing secret, which starts with whsec_. Copy it straight away, because Nexus doesn’t show it again: create a Nexus Webhook credential, paste it into its Signing secret field and choose that credential in the component’s Credential field.
  5. Deploy the flow again and click Send test in Nexus to check that the notification arrives.

Output

The Data output delivers the event with this data:

  • event: the event, for example deal.stage_changed.
  • event_id and delivery_id: the event’s ID and this delivery’s ID.
  • occurred_at: when it happened.
  • contact, deal, previous_stage, resource and tender: the full details of the contact, the deal, the previous stage, the resource or the tender, depending on the event.
  • Shortcuts for what is used most: contact_id, contact_name, contact_email, contact_company, deal_id, deal_title, deal_amount, deal_status, stage_name and url (the link to the item in Nexus).

If an event arrives that isn’t ticked in Events, a test notification or a repeated delivery, the flow stops at this component without an error. If the signature isn’t valid or is too old, the notification is rejected.

Example

A software company wants every new customer to start their training as soon as the sale closes.

  1. Add Nexus Webhook, tick deal.stage_changed in Events and choose the Nexus Webhook credential with your Nexus webhook’s secret.
  2. Connect Data to a Data Conditional Router with deal_status in Key Name, equals and WON in Compare Value.
  3. Connect its True Output to AcademIA Enrollment with the Invite to Path operation, the welcome path in Path ID and the contact_email value in Emails.
  4. Add a welcome email to the customer with the instructions to sign in to AcademIA.

Good practices

  • Always use a Nexus Webhook credential. Without it the signature isn’t checked and anyone who has the flow’s address can start it.
  • Tick only the events you are going to use, and the same ones in Nexus and in Events.
  • contact.updated only arrives when someone edits the contact by hand in Nexus, not when it changes through an import or an automation.
  • A flow can only have one webhook component.

Security and limitations

  • Nexus retries the notifications that fail, so the same event may arrive more than once. Skip repeated deliveries prevents the flow from running twice.
  • If you change the secret in Nexus or create another webhook, edit the Nexus Webhook credential and put the new whsec_… in Signing secret: with the old one, notifications are rejected.
  • The notification carries the basic details of the contact or the deal. To read more, use Nexus CRM with the ID that comes in the event.
  • When you test by pasting an event into Data, the signature isn’t checked: it is only checked on real calls.