Setup Guide — Epic Scout

Configure your brand

Before embedding the widget or sending digests, set your brand name, sender details, and accent colour. This is what your audience sees — not Epic Scout branding.

Open Settings in your dashboard

Jobs

Subscribers

Settings

API Key

Email Branding

Brand Name

Health Recruit AU

From Name (email sender)

Health Recruit Jobs

From Email

jobs@healthrecruit.com.au

Fill in your branding fields

Complete all six fields. These appear in outgoing email digests and the widget config.

Field	Example	Used in
brand_name	Health Recruit AU	Email subject, widget header
from_name	Health Recruit Jobs	Email "From" display name
from_email	jobs@yoursite.com.au	Email sender address
accent_color	#0ea5e9	Widget buttons, email highlights
site_url	https://yoursite.com.au	Email footer logo link
manage_url	https://billing.stripe.com/…	Email "manage subscription" link

✓ Use a real email address you control for from_email — digest emails are sent from your address, not ours. Check your inbox for a test before adding subscribers.

Click Save Branding

Your settings are saved immediately. You can update them at any time — changes take effect on the next digest send and widget load.

Embed the job feed widget

Two lines of HTML. Paste into any page — WordPress, Webflow, Squarespace, or plain HTML. The widget pulls live jobs from your feed, filtered and scored.

Copy your embed code from Settings

In your dashboard under Settings → Widget Embed Code, your personalised snippet is ready to copy. It includes your unique feed slug.

Widget embed code

<div data-tenant="your-slug"
     data-limit="10"
     data-min-score="70"
     data-theme="dark"></div>
<script src="https://theepic.shop/widget.js" async></script>

ℹ Replace your-slug with your actual feed slug (the one you chose during signup). It's shown in your Settings page.

Paste into your page

Place the snippet anywhere in the <body> of your page where you want the job feed to appear. The widget is responsive and inherits your page's font stack unless overridden.

Attribute reference

Attribute	Default	Description
data-tenant	required	Your feed slug from the Settings page
data-limit	10	Max listings to display (1–50)
data-min-score	70	Minimum AI score to show (0–100). Higher = more selective.
data-theme	dark	`dark` or `light`
data-category	none	Filter by category, e.g. `nursing`, `engineering`

Platform-specific instructions

WordPress Custom HTML block ›

In the WordPress block editor, click + and add a Custom HTML block. Paste the embed code into it. Publish or preview your page to see the widget.

Webflow Embed element ›

Add an Embed element (Components → Embed) to your Webflow canvas. Paste the embed code and click Save & Close. The widget renders in the published site (not in the Webflow editor preview).

Squarespace Code block ›

Add a Code block to your page. Paste the embed code. Squarespace restricts custom scripts on some plans — you'll need a Business plan or above for external scripts to load.

Plain HTML Paste anywhere in <body> ›

Paste the snippet directly into your .html file at the position where you want the feed to appear. No build step required.

Add subscribers

Subscribers receive your branded email digest. You can add them manually in the dashboard, import them, or capture them automatically via the API (developer path).

Open the Subscribers page

In your dashboard, click Subscribers in the sidebar. You'll see your full subscriber list and an add form at the bottom.

Add a subscriber

Fill in the form at the bottom of the page. Required field is email — the rest can be left at defaults to start.

Field	Default	Description
Email	required	Subscriber's email address
Tier	free	Your internal tier label — use to segment digest content
Categories	none	Job categories this subscriber wants, comma-separated (e.g. `nursing, aged care`)
Keywords	none	Keyword filter for listings (e.g. `ICU, remote`)

✓ You are responsible for obtaining consent from your subscribers before adding them. See our Privacy Policy and the Spam Act 2003 (Cth) for requirements.

Removing subscribers

Click the Remove button next to any subscriber to mark them as unsubscribed. They will not receive future digests. For bulk management or automated unsubscribes, use the API (developer tab).

Email digest delivery

Epic Scout sends branded job digest emails to your subscribers on a configured schedule. Emails go out under your brand name and sender address — not ours.

How digests work

Once your branding is saved and you have at least one active subscriber, the digest engine runs automatically. It selects the top-scoring jobs from the past 7 days, personalises the list per subscriber based on their categories and keywords, and sends a formatted email from your configured address.

ℹ Digest frequency is configured per account. Contact hello@theepic.shop to set your preferred schedule (daily, twice-weekly, weekly).

What the email includes

Each digest contains:

Your brand name and accent colour
Top job listings with title, source board, AI score, and salary/budget
Direct link to each listing
Your site URL in the footer
Unsubscribe link (required by law)

Test your setup

Add your own email address as a subscriber to receive a test digest. Remove it once you're happy with the branding. If the email doesn't arrive within a few minutes, check your spam folder and verify your from_email address is correct in Settings.

→

Authentication

All authenticated API endpoints require your API key. Find it in your dashboard under API Key. Keys are prefixed es- and are tenant-scoped.

Header (recommended)

curl https://theepic.shop/api/v1/jobs \
  -H "X-API-Key: es-your-api-key-here"

Query parameter (alternative)

curl "https://theepic.shop/api/v1/jobs?api_key=es-your-api-key-here"

✓ Use the header form in production — query params can appear in server logs. You can regenerate your key in the dashboard; the old key stops working immediately.

Base URL for all API calls:

https://theepic.shop/api/v1/

Interactive Swagger docs: theepic.shop/api/docs

→

Jobs API

Retrieve AI-scored job listings from your feed. Authenticated endpoint — returns only jobs belonging to your tenant.

GET /api/v1/jobs Authenticated

Returns paginated job listings for your tenant, ordered by AI score descending.

Example request

curl https://theepic.shop/api/v1/jobs \
  -H "X-API-Key: es-your-api-key-here"

Example response

{
  "jobs": [
    {
      "title": "Financial Controller",
      "url": "https://seek.com.au/job/...",
      "source": "seek",
      "ai_score": 85,
      "budget": "$150,000 – $155,000",
      "categories": "finance, accounting",
      "skills": "CPA, MYOB",
      "scrape_date": "2026-05-02"
    }
  ],
  "total": 142,
  "page": 1,
  "per_page": 20
}

→

Subscribers API

Manage subscribers programmatically. Use this to build your own signup forms, sync your CRM, or handle bulk imports.

GET /api/v1/subscribers Authenticated

Example

curl https://theepic.shop/api/v1/subscribers \
  -H "X-API-Key: es-your-api-key-here"

Response

{
  "total": 34,
  "page": 1,
  "per_page": 50,
  "subscribers": [
    {
      "email": "jane@example.com",
      "tier": "member",
      "status": "active",
      "categories": "nursing, aged care",
      "keywords": "ICU",
      "min_budget": null
    }
  ]
}

POST /api/v1/subscribers Authenticated

Add a subscriber to your pool. Idempotent — posting an existing email returns 200 without error.

Request body

Field	Type	Required	Description
email	string	yes	Subscriber email address
tier	string	no	Your internal tier label (e.g. `free`, `member`)
status	string	no	Default: `active`. Use `pending` for double opt-in flows.
categories	string	no	Comma-separated job categories
keywords	string	no	Comma-separated keyword filters
min_budget	integer	no	Minimum salary/rate filter (AUD)

Example

curl -X POST https://theepic.shop/api/v1/subscribers \
  -H "X-API-Key: es-your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "jane@example.com",
    "tier": "member",
    "categories": "nursing, aged care",
    "keywords": "ICU"
  }'

DELETE /api/v1/subscribers/{email} Authenticated

Mark a subscriber as unsubscribed. They will not receive future digests.

Example

curl -X DELETE \
  "https://theepic.shop/api/v1/subscribers/jane@example.com" \
  -H "X-API-Key: es-your-api-key-here"

→

Widget API

Two public endpoints — no API key required. Use these to fetch job data directly into your own frontend without the embeddable script.

GET /api/v1/widget/{slug}/jobs Public — no auth

Returns sanitised job data for a feed. Safe to call client-side.

Query parameters

Param	Default	Description
limit	10	Number of results (1–50)
min_score	70	Minimum AI score filter (0–100)
category	none	Filter by category string (partial match)

Example

curl "https://theepic.shop/api/v1/widget/your-slug/jobs?limit=20&min_score=75"

GET /api/v1/widget/{slug}/config Public — no auth

Returns your public branding config (brand name, accent colour, site URL). Used by the embed script — also useful if you're building a custom widget.

Example response

{
  "slug": "your-slug",
  "brand_name": "Health Recruit AU",
  "accent_color": "#0ea5e9",
  "site_url": "https://healthrecruit.com.au"
}

✓ Full interactive docs with try-it-out panels at theepic.shop/api/docs