06/30/2022 How to Enable Integration with Graphus


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


  • You must have access to both BullPhish ID and Graphus accounts. You must also configure organizations and domains at the Graphus end.  
  • An SMB organization must associate with a unique domain. Check out a detailed guide on How to ensure an SMB organization is associated with a unique domain?
  • Only partner admins will be able to configure this integration.  
  • Only Mailboxes protected by Graphus will receive campaign emails right into their inbox. It is because Graphus needs access to the API to protect the inboxes. Unprotected users will not receive the BullPhish ID campaign email, and the campaign status appears as "Email Error."

    Follow this link to review protected users on Graphus side: https://cloud.graph.us/orgUsersLicense?licenseType=protected 

    • IMPORTANT NOTE: In our upcoming release, organizations with unlicensed users will be in an Inactive state and cannot use this integration. The integration can only be used for licensed users.


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


 2. Navigate to MSP Administration » Integrations » and click the BullPhish ID "Generate API Key" button. 



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


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


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.



How to disconnect the integration:

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



  • 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 re-direct you to the Integrations page. Click "Generate API Key" to create a new API Key (MSP Key is also known as API Key).


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

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

4. Log in to 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. 

9.1.png6. Click the plug icon to set up the integration with Graphus. 

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


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. 


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


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


When one or more SMB organization is disabled/ removed from the Graphus side, the status would be "Inactive," and when you hover on the state, the following message would be displayed.


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. 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 abovementioned requirements. 
  • Cause of Inactive Status:  
    • This status appears when an organization is disabled/deleted on the Graphus site.

User can manually run re-synchronisation under Settings > Integrations > Graphus Integration page. "It may check integration with Graphus daily and provides the sync information of Active/Inactive. 


    • The status will be inactive if an organization does not have a unique domain. 


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


  • 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.  


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

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 in to BullPhish ID.
  2. Go to "View All Campaigns" under "Phishing Simulations." 
  3. Check the "Service" column.  


"View All Campaigns" service logos and their meanings:

blobid1.pngWhen a campaign is scheduled in the future, a scheduled logo will be shown.

blobid2.pngWhen a campaign is in progress, canceled, or completed state with a Graphus logo, then the campaign will use a Graphus integration as a service.

blobid3.pngWhen a campaign is in progress, canceled, or completed state, with an SMTP logo, then the campaign will use an SMTP service. 

Related Articles 


Was this article helpful?
0 out of 0 found this helpful
Have more questions? Contact us