Skip to content Skip to navigation Skip to topbar

Get Signed Event Webhook's Public Key

API Overview

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.

Operation overview

GET/v3/user/webhooks/event/settings/signed/{id}

Base url: https://api.sendgrid.com

This endpoint allows you to retrieve the public key for a single Event Webhook by ID.

If you do not pass a webhook ID to this endpoint, it will return the public key for your oldest webhook by created_date. This means the default key returned by this endpoint when no ID is provided will be for the first webhook you created. This functionality allows customers who do not have multiple webhooks to use this endpoint to retrieve their only webhook's public key, even if they do not supply an ID. If you have multiple webhooks, you can retrieve their IDs using the Get All Event Webhooks endpoint.

Once you have enabled signature verification for a webhook, you will need the public key provided to verify the signatures on requests coming from Twilio SendGrid. You can use the webhook ID to enable or disable signature verification with the endpoint dedicated for that operation.

For more information about cryptographically signing the Event Webhook, see Getting Started with the Event Webhook Security Features.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

on-behalf-ofstringOptional

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.

Path parameters

Property nameTypeRequiredDescription

idstringrequired

The ID of the Event Webhook you want to retrieve.

Responses

200404

Success

SchemaExample

Property nameTypeRequiredDescriptionChild properties

idstring

A unique string used to identify the webhook. A webhook's ID is generated programmatically and cannot be changed after creation. You can assign a natural language identifier to your webhook using the friendly_name property.

public_keystring

The public key you can use to verify the Twilio SendGrid signature.

Get Signed Event Webhook's Public Key

Node.js

Python

Java

PHP

Ruby

curl


_19const client = require('@sendgrid/client');
_19client.setApiKey(process.env.SENDGRID_API_KEY);
_19
_19const id = "ZGkrHSypTsudrGkmdpJJ";
_19
_19const request = {
_19  url: `/v3/user/webhooks/event/settings/signed/${id}`,
_19  method: 'GET',
_19  
_19}
_19
_19client.request(request)
_19  .then(([response, body]) => {
_19    console.log(response.statusCode);
_19    console.log(response.body);
_19  })
_19  .catch(error => {
_19    console.error(error);
_19  });