Integrations/Connectors
Phishing: GoPhish Integration
What it is
Full integration with GoPhish for managing simulated phishing campaigns directly in EterShield.
How to configure
In Settings → Integrations → Gophish:
| Field | Example |
|---|---|
| URL | https://<your-gophish-server>:3333 |
| API Key | Generated in GoPhish → Account Settings |
To receive real-time events, configure the webhook in GoPhish pointing to:
POST https://etershield.etergrowth.com/api/v1/phishing/webhook
Header: X-Gophish-Signature: <hmac-sha256>
The HMAC secret is defined in the EterShield webhook configuration.
Management endpoints
| Method | Endpoint | Description | Minimum role |
|---|---|---|---|
| GET | /api/v1/phishing/campaigns |
List campaigns | VIEWER |
| POST | /api/v1/phishing/campaigns |
Create campaign | MANAGER |
| GET | /api/v1/phishing/campaigns/[id] |
Campaign details | VIEWER |
| PATCH | /api/v1/phishing/campaigns/[id] |
Update campaign | MANAGER |
| DELETE | /api/v1/phishing/campaigns/[id] |
Delete campaign | ADMIN |
| POST | /api/v1/phishing/campaigns/[id]/launch |
Launch campaign in GoPhish | ADMIN/MANAGER |
Inbound webhook (GoPhish events)
POST /api/v1/phishing/webhook
X-Gophish-Signature: sha256=<hmac>
Content-Type: application/json
The endpoint validates the HMAC-SHA256 signature (fail-closed: it rejects if the signature is missing or invalid). Events processed: clicked, reported.
Automatic synchronization
The phishing-sync scheduler job (every 30 min) syncs the state of ACTIVE campaigns with GoPhish, updating metrics (emails sent, clicked, reported).
What it produces
Campaign metrics available in the Awareness → Phishing module of the dashboard.
Coming soonThis page will be available soon.