Skip to main content
Beta

Integration: BullPhish ID & INKY

Written By Matt Sywulak

Last updated About 2 hours ago

Security and navigation

NAVIGATION: Settings > Integrations > BullPhish ID

PERMISSIONS: Super Admin, or any role with the API keys create and delete permissions. Roles with API keys read permission can view the integration's status but can't connect it.

About this integration

The BullPhish ID integration is the recommended way to get BullPhish ID phishing simulations and security awareness training emails to your users. Instead of sending these messages as regular email, which mail filtering can block or delay, BullPhish ID hands each message to INKY. INKY then places it directly in the recipient's inbox using the Microsoft 365 or Google Workspace access you've already granted INKY.

Simulations delivered this way carry the same INKY banner that a real email would, so what your users see during training matches what they see every day.

The BullPhish ID integration requires an INKY Pro or INKY Advanced subscription and is gated as a beta feature. Contact your account team to have it enabled for your organization. It isn't available during an INKY trial.

Prerequisites

  • The BullPhish ID integration is enabled for your organization (beta).

  • An active BullPhish ID account, and admin access to its integration settings.

  • For every team you want simulations delivered to, INKY has both Domain & Directory Access and Remediation Access granted. INKY uses these to confirm each recipient's mailbox and place the message in it.

  • The recipient's email domain belongs to a team INKY protects.

  • The backup method is set up, so simulations still arrive if INKY can't deliver one directly. See Allow BullPhish ID simulations through Microsoft 365 (backup method).

Use case

You run phishing simulations and training for your customers with BullPhish ID. You want those messages to arrive reliably, without allowlisting gaps, and to look exactly like real mail does once INKY has processed it.

How to connect BullPhish ID

You can connect BullPhish ID at the organization level, which covers every team in the organization, or for a single team. If an organization-level connection already exists, a team shows Connected via organization, and you can optionally create a team-specific key for it.

To connect BullPhish ID, complete the following steps:

  1. In INKY, go to Settings > Integrations, and select the organization or team you want to connect.

  2. Click the BullPhish ID card.

  3. Review the overview, then click Get Started.

  4. Click Generate API Key, then copy the key. You won't be able to view it again after you leave this page.

  5. In BullPhish ID, go to Integrations > INKY, and paste the key.

  6. Back in INKY, click I've Pasted the Key — Verify Connection.

INKY waits up to two minutes for BullPhish ID's first delivery. When one arrives, the integration shows Connected along with the time of the first delivery.

Note: Verification completes only when BullPhish ID actually delivers a message, so it needs a simulation or training email to be scheduled. If nothing is scheduled yet, click Skip Verification. The integration shows Pending until the first delivery arrives, then changes to Connected on its own.

How to replace or revoke the API key

INKY doesn't store a readable copy of the key. If you've lost it, or need to rotate it, you'll replace it.

To replace or revoke the key, complete the following steps:

  1. Go to Settings > Integrations, and click the BullPhish ID card.

  2. Choose one of the following:

    • Regenerate Key creates a new key and revokes the old one immediately. Paste the new key into BullPhish ID right away.

    • Revoke & Start Over or Revoke Key revokes the key and disconnects BullPhish ID until you generate a new one.

    [SCREENSHOT: "Previously Generated Key" panel with Regenerate Key and Revoke & Start Over]

Note: BullPhish ID can't deliver through INKY from the moment a key is revoked. Until you paste a new key, simulations go out as regular email and rely on the backup method.

FAQ

Do I still need the Microsoft 365 Advanced Delivery settings?

Yes, as the backup method. If INKY can't deliver a message, for example because a team's Remediation Access has lapsed, BullPhish ID falls back to sending it as regular email. Advanced Delivery makes sure those messages still arrive. See Allow BullPhish ID simulations through Microsoft 365 (backup method).

Why does the integration still show Pending?

The key has been generated but BullPhish ID hasn't delivered a message with it yet. Check that the key is pasted into BullPhish ID and that a simulation or training email is scheduled.

Why don't I see BullPhish ID on the Integrations page?

The integration is in beta and has to be enabled for your organization. Contact your account team. If you see the card but can't connect it, check your plan and your role's API keys permissions. Until it's enabled, use the backup method.

Some recipients didn't get a simulation through INKY. Why?

INKY only delivers to mailboxes on a team it protects, with Domain & Directory Access and Remediation Access granted. If either is missing for a recipient's team, BullPhish ID falls back to regular email for that recipient, and the backup method applies.

Was this helpful?

Still need help? Ask the team