Modules
Sign in
Get Help

BullPhish ID Integration with Graphus

Introduction

Use Graphus integration to eliminate the need for domain whitelisting and ensure 100% campaign deliverability to your end users. The Graphus API gives BullPhish ID the ability to place phishing and training emails directly into end user inboxes as opposed to sending them through the internet, saving you hours of whitelisting time.

This Guide is designed for users who want to enable BullPhish ID integration with Graphus. It walks you through a step-by-step integration process. This integration is highly secured since BullPhish ID and Graphus organizations get synced with an API Key and ensure 100% email deliverability.   

PREREQUISITES  

Instructions

1. Log into your Graphus account. Fill in the credentials and click Log in.

 2. Navigate to MSP Administration » Integrations » and click the BullPhish ID Connect button. 

0.png

3. Once you click OK, you'll see the Edit button. To generate Graphus into BullPhish, copy the API key. 

2.png

 

Note: This window displays the Sync Information (Last generated and Generated by).

1.png

How to generate a new API key:

  • You may generate a new API Key using the Refresh API Key checkbox.
    • You can refresh the API key in the following cases: If you feel there might be a breach/security attack. Or if you want to use the new security key as a proactive security measure.
    • Please type REFRESH in the inbox field to confirm the same. (Why should I type this? It is a best technology practice to have a confirmation window. Typically, a quick step; is a way of thwarting spam and automated data extraction from websites.) 
      • The following pop-up appears on the screen when you miss typing REFRESH in the given field.
      • Click Refresh to conclude.

Refresh.png

REfresh_Sucess.PNG

How to disconnect the integration:

  • You can disconnect the integration completely using the Disconnect API Key button and confirm by typing the same in the field.  

Disconnect.png

Disconnect_Success.png

  • Note: Once you disconnect the API Key, the key gets invalid on the BullPhishID portal and will transfer all future sending campaigns to the SMTP service. In such a scenario, an administrator must ensure that the required whitelisting is done to ensure email deliverability.
    • In case of disconnection, campaign emails in the processing or scheduled state will not be sent via Graphus integration. To avoid such a case, enable the integration with a new API key before the campaign scheduled date/ time.

Note: Disconnect API Key will redirect you to the Integrations page. Click Connect to create a new API Key (MSP Key is also known as API Key).

0.png

Note: Several organizations can use the same API key from Graphus without any limitations.

Once you have copied the API Key, follow the below steps in BullPhish ID:

4. Log in to the BullPhish ID account.

5. Navigate to your left side of the screen and click Integrations under Settings. 

 This page shows you the available integration services. Currently, you can see Graphus as a service. 

61.png

6. Click Connect to set up the integration with Graphus. This Connect button is available for you when you do not have an active integration. (Scroll down for more details on the Integration page statuses and action buttons.

7. To begin integration, enter the API Key you copied from the Graphus portal and click Verify.

9.2.PNG

Once API Key is verified successfully, the domains on the Graphus side will get synchronized on the screen.  

11.pngAvailable Domains: After synchronization, the domains available for use in advanced simulations are listed below. 

Graphus_Screen_Shot_Blurred.png

  • If all domains from Graphus are associated with BullPhish ID SMB organizations, synchronization is completed; you will notice the following message. 

MicrosoftTeams-image__28_.png

  • If some of the domains from Graphus are not associated with BullPhish ID SMB organizations, you will notice the following message. 

MicrosoftTeams-image__27_.png

Important: Check out the following Guide if no SMB organization(s) is integrated with Graphus. Why didn't my SMB organization(s) sync after integration with Graphus?

 8. A Status column is available on the Graphus integration page, where you can identify if the service is Active/Inactive/Error. Once the integration is active, synchronization happens each time whenever a user(s) opens the Graphus integration page. 

Graphus integration statuses and their meanings:

  • Cause of Active Status:  
    • Integration is displayed as Active when you meet all the above-mentioned requirements. 

Graphus_Screen_Shot_Arrow.png

  • Cause of Inactive Status:  
    • The status will be Inactive if an organization does not have a unique domain. 

Graphus_Screen_Shot_Inactive_arrow.png

  • Cause of Error Status: 
    • Organizations with unlicensed users will be auto-set to an Error state and cannot use Graphus integration. Only licensed users can use this integration. The download action icon appears only for unlicensed users with an error status. You can download a CSV file with a list of unlicensed users and buy licenses for Graphus or Google/Azure for this specific list of CSV file users. Click the Download icon.

Graphus_Screen_Shot_Arror_for_Error_and_circle.png

Error_sTATUS.png

 

  • Cause of Email Error Status on the detailed campaign page:  
    • This status appears when emails cannot be delivered to unlicensed Microsoft users.

Microsoft_Licence_blur.jpg

  • Cause of In-Process Status:  
    • This status appears when integration is ongoing or still in process.

You can also view the sync information from the Updated column. It displays the last sync date and time.  

10.png

Once the integration is active, you can start scheduling the campaigns using the Graphus service.  

Campaign Service information

After successful email campaign delivery, you can view the campaign service information from the View All Campaign page.  

  • Go to the View All Campaigns page under Phishing Simulations to view campaigns using Graphus integration as a service. 
  1. Log into BullPhish ID.
  2. Go to View All Campaigns under Phishing Simulations.
  3. Check the Service column.  

14.png

View All Campaigns Service icons and their meanings:

blobid1.pngThe scheduled icon is shown when a campaign is scheduled in the future. This icon is also displayed when a campaign is canceled while in the Scheduled Status

blobid2.pngThe Graphus icon is shown for campaigns using Graphus integration as the Service. The icon is displayed when a campaign is in progress, has been canceled (after processing starts), or completed. 

blobid3.pngThe SMTP icon is shown for campaigns using SMTP as the Service. The icon is displayed when a campaign is in progress, canceled (after processing starts), or completed.

Graphus_SMTP icons.pngBoth the Graphus icon and the SMTP icon are displayed when a campaign starts processing using Graphus integration as the Service but then has to use SMTP (i.e, Graphus integration becomes inactive). The icons are displayed in the reverse order when a campaign starts processing using SMTP as the Service but then uses Graphus integration (i.e, Graphus integration is enabled). 

Campaign Service scenarios based on Graphus integration status  

  • Campaigns that start while the Graphus service is in the Error Status:
    Graphus integration cannot be enabled for an organization that doesn't have all user mailboxes protected by Graphus. 
    Error.png

    Therefore, campaign emails will be delivered using the SMTP service.

    Error 2.png
  • Targets not protected by Graphus that are added to an in-progress campaign:
    When an organization's Graphus integration status is Active, all targets are protected by Graphus and each will receive the campaign email via Graphus. However, if a new target is added, either manually in BullPhish ID or by directory sync, to a group for which a campaign is in-progress, the status of the integration becomes Inactive. The new target will receive the campaign email via SMTP.
    Any new targets added when the integration is Inactive, regardless of whether the target is protected by Graphus, will receive the campaign email via SMTP.
    In the Service column on the Training & Awareness Dashboard, the Graphus icon indicates that the campaign emails were sent initially by Graphus and when the integration became Inactive,  emails were sent by SMTP, as indicated by the SMTP icon.

    In progress.png 

Integration page action buttons and statuses are briefed below.

  • You can see the options menu on your active integration page and perform the following actions from the dropdown: View and Disconnect
    • View: It allows you to view the Graphus integration page

    • Disconnect: It disconnects the active integration with Graphus. 

62.png

The following Statuses are available for the integration page:

  • Not connected: You can view this status when integration has not yet been configured. 
  • Connected: This status is available when integration is live and connected with Graphus.
  • Syncing: This status appears when sync is in progress with Graphus.
    • Now you can see integration in Sync status with a message saying Syncing in Progress. This might take a while. Refresh the page in a few minutes.

6.png

Disconnect Graphus integration: You can manually disconnect the integration with Graphus. 

  • Click Disconnect from the options menu on your active integration page.

7.png

  • A pop-up appears on the screen with the following message: "Are you sure you want to disconnect integration with Graphus?" Click Disconnect if you want to proceed. 

1.PNG

Note: The integration gets disconnected and cannot be undone. 

8.png

  • Revision Date
    Added description when Graphus and SMTP icons are displayed.

    Added section: Campaign Service scenarios based on Graphus integration status.

    2/14/24

     

     

 

Related Articles 

 

Have more questions?

Contact us

Was this article helpful?
0 out of 0 found this helpful

Provide feedback for the Documentation team!

Browse this section