Twilio SendGrid

Details

ID	`Twilio SendGrid`
Provider	Twilio
Category	Analytics & SIEM
From Version	8.4.0
Docker Image	`demisto/python3:3.12.13.10116658`
Supported Modules	XSIAM

README

Twilio SendGrid is a cloud-based email delivery platform that provides email activity tracking and analytics. Use this integration to collect email activity events such as deliveries, opens, clicks, bounces, and spam reports.
Note: You must purchase additional email activity history to access the Email Activity Feed API.

This is the default integration for this content pack when configured by the Data Onboarder in Cortex XSIAM.

Configure Twilio SendGrid in Cortex

Parameter	Description	Required
Server URL	The SendGrid API base URL. Default: api.sendgrid.com	True
API Secret Key	Your SendGrid API key with Email Activity read permissions.	True
Maximum Email Activity Messages per fetch	Maximum number of events to fetch per fetch run. The API is limited to 1000 events per call, so multiple calls will be made if needed. Default is 10000.	False
Trust any certificate (not secure)		False
Use system proxy settings		False

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

twilio-sendgrid-get-events

Returns email activity events from Twilio SendGrid. This command is used for developing/debugging and is to be used with caution, as it can create events, leading to event duplication and exceeding the API request limitation.

Base Command

twilio-sendgrid-get-events

Input

Argument Name	Description	Required
should_push_events	Set this argument to True in order to create events, otherwise the command will only display them. Possible values are: True, False. Default is False.	Required
limit	Maximum number of events to retrieve. The API is limited to 1000 events per call. Default is 1000.	Optional
from_date	Start time for event retrieval. Supports relative times (e.g., “3 days”) or ISO format (e.g., “2024-01-15T00:00:00Z”).	Optional
to_date	End time for event retrieval. Supports relative times or ISO format.	Optional

Context Output

There is no context output for this command.

Configuration parameters

server_url — Server URL (required)
api_key — API Secret Key (required)
max_fetch — Maximum Email Activity Messages per fetch
eventFetchInterval — Events Fetch Interval
insecure — Trust any certificate (not secure)
proxy — Use system proxy settings

Commands (1)

twilio-sendgrid-get-events
Returns email activity events from Twilio SendGrid. This command is used for developing/debugging and is to be used with caution, as it can create events, leading to event duplication and exceeding the API request limitation.

Source

TwilioSendGrid.py TwilioSendGrid_test.py TwilioSendGrid.yml TwilioSendGrid_description.md command_examples.txt

Download History Raw

category: Analytics & SIEM
provider: Twilio
commonfields:
  id: Twilio SendGrid
  version: -1
description: Twilio SendGrid is a cloud-based email delivery platform that provides email activity tracking and analytics.
display: Twilio SendGrid
name: Twilio SendGrid
sectionorder:
- Connect
- Collect
configuration:
- display: Server URL
  name: server_url
  defaultvalue: api.sendgrid.com
  type: 0
  required: true
  section: Connect
- display: API Secret Key
  name: api_key
  type: 9
  required: true
  section: Connect
  hiddenusername: true
  displaypassword: API Secret Key
- additionalinfo: Maximum number of email activity messages to fetch per fetch run. The API is limited to 1000 events per call, so multiple calls will be made if needed.
  defaultvalue: '10000'
  display: Maximum Email Activity Messages per fetch
  name: max_fetch
  type: 0
  required: false
  section: Collect
- defaultvalue: '1'
  display: Events Fetch Interval
  name: eventFetchInterval
  type: 19
  required: false
  section: Collect
  advanced: true
- display: Trust any certificate (not secure)
  name: insecure
  type: 8
  required: false
  section: Connect
  advanced: true
- display: Use system proxy settings
  name: proxy
  type: 8
  required: false
  section: Connect
  advanced: true
script:
  commands:
  - name: twilio-sendgrid-get-events
    description: Returns email activity events from Twilio SendGrid. This command is used for developing/debugging and is to be used with caution, as it can create events, leading to event duplication and exceeding the API request limitation.
    arguments:
    - auto: PREDEFINED
      defaultValue: 'false'
      description: Set this argument to True in order to create events, otherwise the command will only display them.
      name: should_push_events
      predefined:
      - 'true'
      - 'false'
      required: true
    - description: Maximum number of events to retrieve. The API is limited to 1000 events per call. Default is 10000.
      name: limit
      defaultValue: '1000'
      required: false
    - description: Start time for event retrieval. Supports relative times (e.g., "3 days") or ISO format (e.g., "2024-01-15T00:00:00Z").
      name: from_date
      required: false
    - description: End time for event retrieval. Supports relative times or ISO format.
      name: to_date
      required: false
  dockerimage: demisto/python3:3.12.13.10116658
  isfetchevents: true
  runonce: false
  script: ''
  subtype: python3
  type: python
fromversion: 8.4.0
marketplaces:
- marketplacev2
- platform
tests:
- No tests
supportedModules:
- xsiam