company logo

Help center

Go to Smartlead.ai
API Documentation
All collectionsAPI, Integrations, and Webhooks How to test a Smartlead webhook with sample payloads

How to test a Smartlead webhook with sample payloads

Use the Send Test button to post a sample event to your webhook URL, check the payload your server receives, and fix your handler before going live.

The Send Test button posts a sample event to your webhook URL. Use it to see the payload and fix your handler before real events start flowing.

A test uses fixed sample data, not data from your account. It proves your URL accepts the request. It does not prove that live events will reach this webhook.

Before you start

  • Your endpoint must accept a POST request with a JSON body.

  • While you build, a request inspector such as webhook.site shows exactly what arrives.

Step 1: Open the webhook form

  1. Go to Settings → Webhook. For a campaign webhook, you can also open the campaign and go to its Settings → Webhooks tab.

  2. Click Add Webhook, or click the pencil icon on an existing webhook.

The Add Webhook or Edit Webhook dialog opens.

Step 2: Send a test event

  1. Enter your Webhook URL.

  2. Under Event Type, select exactly one event.

  3. Click Send Test.

You'll see Event Sent Successfully!! when your server accepted the request. If it didn't, the message shows the error your server returned, for example Request failed with status code 404.

Send Test is greyed out? Enter a URL and select exactly one event.

Step 3: Check what your server received

Each test body includes "is_test": true, so your handler can tell it apart from a real event. Here is a shortened Email Sent sample:

JavaScript
{
  "event_type": "EMAIL_SENT",
  "campaign_id": 111,
  "campaign_name": "OR Tracker",
  "sequence_number": 1,
  "from_email": "[email protected]",
  "to_email": "[email protected]",
  "to_name": "David Carroll",
  "subject": "OR",
  "sent_message": { "message_id": "<[email protected]>", "html": "<div>Opening</div>", "text": "Opening", "time": "2023-09-25T17:27:27.234+00:00" },
  "event_timestamp": "2023-09-25T17:27:27.234+00:00",
  "webhook_id": 111,
  "is_test": true
}

An Email Reply sample adds reply_message (with html, text and time), reply_category and sl_lead_email, and its event_type is EMAIL_REPLY.

Branch your handler on event_type. The values are EMAIL_SENT, FIRST_EMAIL_SENT, EMAIL_OPEN, EMAIL_LINK_CLICK, EMAIL_REPLY, LEAD_UNSUBSCRIBED, LEAD_CATEGORY_UPDATED, EMAIL_BOUNCE, CAMPAIGN_STATUS_CHANGED, MANUAL_STEP_REACHED and MANUAL_REPLY_SENT. Account-level and client-level webhooks can also receive UNTRACKED_REPLIES.

Good to know

  • Real events carry an event ID. It is in the event_id body field and the webhook-id header. Retries reuse the same ID, so use it to skip events you've already processed.

  • Tests are sent once and never retried. Real events that fail are retried automatically, except when your server replies 400, 413 or 422. See How to Retry or Resend Webhooks.

  • Signed webhooks send signed tests. If signing is on, the test carries webhook-id, webhook-timestamp and webhook-signature headers. Save the webhook first: a test is only signed when the URL in the form matches the saved URL. See Secure Your Smartlead Webhooks with Signing (HMAC).

  • Reply with a 2xx within 60 seconds, then do any heavy processing.

If something goes wrong

  • The test fails with a 4xx. The error comes from your endpoint, not Smartlead. Check that the URL is correct, that it accepts POST without extra login, and that any automation scenario on that URL is switched on.

  • The test passes but live events don't arrive. The test skips the checks a live event goes through. Check that the webhook is attached to the right campaign or client and has the right event selected. See How To Resolve Webhook Failures.

Still stuck? Contact support from the chat in your Smartlead dashboard.

Related articles

  • Set Up Smartlead Webhooks for Campaign Automation

  • Secure Your Smartlead Webhooks with Signing (HMAC)

  • How to Retry or Resend Webhooks

Did this answer your question?
😞
😐
😁