Pull data from the Proofpoint ZenGuide Results API

Overview

Get phishing events through the Proofpoint ZenGuide Results API using the HTTP Pull Listener.

HTTP Pull Listener configuration

In Falcon Onum, go to the Listeners area and click New Listener > HTTP Pull. Give a name to your new Listener and enter the following data:

Parameters

N/A

Secrets

You must define these credentials in Onum:

• x-apikey-token will reference your Proofpoint ZenGuide token.

To do it, click Add element and enter a Name for the secret (in this case, x-apikey-token). Then, click the Value field and select New secret to create a new one:

• Give the secret a Name.

• Turn off the Expiration date option.

• Click Add new value and paste the secret corresponding to the value.

• Click Save.

You can now select the secret you just created in the corresponding field.

Learn more about secrets in Onum in this article.

Setup

After entering the required parameters and secrets, you can choose to manually enter the rest of configuration fields, or simply paste the given YAML:

Config as YAML

Toggle ON the Config as YAML option to enable a free text field where you can paste the following YAML:

withTemporalWindow: true
temporalWindow:
  duration: 24h
  offset: 24h
  tz: UTC
  format: "2006-01-02T15:04:05"
withAuthentication: false
withEnumerationPhase: false
collectionPhase:
  paginationType: "page"
  isZeroIndex: false
  pageSize: 100
  request:
    responseType: json
    method: "GET"
    url: "https://results.us.securityeducation.com:443/api/reporting/v0.3.0/phishalarm"
    headers:
      - name: x-apikey-token
        value: ${secrets.x-apikey-token}
    queryParams: 
      - name: filter[_includearchivecampaigns]
        value: "TRUE"
      - name: filter[_receiveddate_start]
        value: ${temporalWindow.from}
  output:
    select: ".data"
    map: "."
    outputMode: "element"

Manually configure

When you're done, click Create labels to move on to the next step and define the required Labels if needed.