Webhooks
The SendGrid Event Webhook sends email event data as SendGrid processes it. This means you can receive data in nearly real-time, making it ideal to integrate with logging or monitoring systems.
Because the Event Webhook delivers data to your systems, it is also well-suited to backing up and storing event data within your infrastructure to meet your own data access and retention needs.
Event types
You can think about the types of events provided by the Event Webhook in two categories: deliverability events and engagement events.
- Deliverability events such as "delivered," "bounced," and "processed" help you understand if your email is being delivered to your customers.
- Engagement events such as "open," and "click" help you understand if customers are reading and interacting with your emails after they arrive.
Both types of events are important and should be monitored to understand the overall health of your email program. The Webhooks API allows you to configure your Event Webhook configurations.
Retrieves Inbound Parse Webhook statistics.
GET /v3/user/webhooks/parse/stats
Base url: https://api.sendgrid.com
This endpoint allows you to retrieve the statistics for your Parse Webhook useage.
SendGrid's Inbound Parse Webhook allows you to parse the contents and attachments of incomming emails. The Parse API can then POST the parsed emails to a URL that you specify. The Inbound Parse Webhook cannot parse messages greater than 30MB in size, including all attachments.
There are a number of pre-made integrations for the SendGrid Parse Webhook which make processing events easy. You can find these integrations in the Library Index.
Authentication
- API Key
Headers
The on-behalf-of header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be "account-id" followed by the customer account's ID (e.g., on-behalf-of: account-id <account-id>). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., on-behalf-of: <subuser-username>). See On Behalf Of for more information.
Query String
The number of statistics to return on each page.
default: NoneThe number of statistics to skip.
default: NoneHow you would like the statistics to by grouped.
default: NoneThe starting date of the statistics you want to retrieve. Must be in the format YYYY-MM-DD
default: NoneThe end date of the statistics you want to retrieve. Must be in the format YYYY-MM-DD
default: The day the request is made.Responses
The date that the stats were collected.
The Parse Webhook usage statistics.
The number of emails received and parsed by the Parse Webhook.
Need some help?
We all do sometimes. Get help now from the Twilio SendGrid Support Team.
Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.
