The Twilio SendGrid Account Provisioning API provides a platform for Twilio SendGrid resellers to manage their customer accounts. This API is for companies that have a formal re...
The Twilio SendGrid Alerts API allows you to specify an email address to receive notifications regarding your email usage or statistics. You can set up alerts to be sent to a sp...
The Twilio SendGrid API Keys API allows you manage your API keys and their settings. Your application, mail client, or website can all use API keys to authenticate access to Sen...
The Twilio SendGrid Domain Authentication API allows you to manage your authenticated domains and their settings. Domain Authentication is a required step when setting up your T...
The Twilio SendGrid Email Activity API allows you to query all of your stored messages, query individual messages, and download a CSV with data about the stored messages. Once r...
The Twilio SendGrid Email Address Validation API provides real-time detailed information on the validity of email addresses. You can integrate this validation process into your ...
The Twilio SendGrid Enforced TLS API allows you to specify whether or not the recipient of your mail send is required to support TLS or have a valid certificate. Twilio SendGrid...
Integrations allows you to connect your SendGrid applications with third-party services and forward SendGrid email events to those external applications. Currently, Integrations...
IP Twilio SendGrid IP Access Management API allows you to control which IP addresses can be used to access your account, either through the SendGrid application user interface o...
The Twilio SendGrid IP Address Management API combines functionality that was previously split between the Twilio SendGrid [IP Address API](https://docs.sendgrid.com/api-referen...
The Twilio SendGrid IP Warm Up API allows you to gradually increasing the volume of mail sent with a dedicated IP address according to a predetermined schedule. This gradual pro...
The Twilio SendGrid IP Address API allows you to add and manage dedicated IP addresses and IP Pools for your SendGrid account and Subusers. If you are sending any significant am...
The Twilio SendGrid Link Branding API allows you to configure your domain settings so that all of the click-tracked links, opens, and images in your emails are served from your ...
The Twilio SendGrid Legacy Marketing Campaigns Campaigns API allows you to manage your marketing email messages programmatically. This API is operational, but we recommend using...
The Twilio SendGrid Legacy Marketing Campaigns Contacts API allows you to manage your marketing contacts programmatically. This API is operational, but we recommend using the cu...
The Twilio SendGrid Legacy Marketing Campaigns Sender Identites API allows you to manage the email addresses used to send your marketing email. This API is operational, but we r...
The Twilio SendGrid Mail Settings API allows you to retrieve and configure the various Mail Settings available. Mail Settings instruct SendGrid to apply specific settings to eve...
The Twilio SendGrid v3 Mail API allows you to send email at scale over HTTP. The Mail Send endpoint supports many levels of functionality, allowing you to send templates, set ca...
The Twilio SendGrid Marketing Campaigns Contacts API allows you to manage all of your marketing contacts programmatically. You can also import and export contacts using this API...
The Twilio SendGrid Marketing Campaigns Custom Fields API allows you to add extra information about your marketing contacts that is relevant to your needs. For example, a fashio...
The Twilio SendGrid Designs API offers the ability to manage assets stored in the Twilio SendGrid [Design Library](https://mc.sendgrid.com/design-library/my-designs). The Design...
The Twilio SendGrid Marketing Campaigns Lists API allows you to manage your contacts lists programmatically. Lists are static collections of Marketing Campaigns contacts. You ca...
The Twilio SendGrid Marketing Campaigns Segments V2 API allows you to create, edit, and delete segments as well as retrieve a list of segments or an individual segment by ID. Se...
This API was deprecated on December 31, 2022. Following deprecation, all segments created in the Marketing Campaigns user interface began using the [Segmentation v2 API](https:/...
The Twilio SendGrid Marketing Campaigns Senders API allows you to create a verified sender from which your marketing emails will be sent. To ensure our customers maintain the be...
The Twilio SendGrid Single Sends API allows you to create, manage, and send Single Sends. You can also search Single Sends and retrieve statistics about them to help you maintai...
The Marketing Campaigns Stats API allows you to retrieve statistics for both Automations and Single Sends. The statistics provided include bounces, clicks, opens, and more. You ...
The Twilio SendGrid Test Email API allows you to test a marketing email by first sending it to a list of up to 10 email addresses before pushing to a contact list or segment. Wi...
The Twilio SendGrid Partner Settings API allows you to integrate your SendGrid account with our partners to increase your SendGrid experience and functionality. For more informa...
The Recipients' Data Erasure API allows Twilio SendGrid customers to delete their own customers' personal data from the Twilio SendGrid Platform. The use of this API facilitates...
The Twilio SendGrid Reverse DNS API (formerly IP Whitelabel) allows you to configure reverse DNS settings for your account. Mailbox providers verify the sender of your emails by...
The Twilio SendGrid Scheduled Sends API allows you to cancel or pause the send of one or more emails using a batch ID. A `batch_id` groups multiple scheduled mail send requests ...
The Twilio SendGrid Scopes API allows you to retrieve the scopes or permissions available to a user, see the user's attempts to access your SendGrid account, and, if necessary, ...
The SendGrid Engagement Quality (SEQ) API allows you to retrieve metrics that define the quality of your email program. An SEQ score is correlated with: - The quality of the dat...
The Single Sign-On API allows you to manage your SAML 2.0 SSO configurations. You can also work with your SSO integrations using the SSO section of the [Twilio SendGrid applicat...
The Twilio SendGrid Statistics API allows you to retrieve the various statistics related to your email program. Tracking your emails is an important part of being a good sender ...
The Twilio SendGrid Subusers API allows you to create and manage your Subuser accounts. Subusers are available on [Pro and Premier plans](https://sendgrid.com/pricing), and you ...
The Twilio SendGrid Suppressions API allows you to manage your Suppressions or Unsubscribes and Suppression or Unsubscribe groups. With SendGrid, an unsubscribe is the action an...
The Twilio SendGrid Teammates API allows you to add, manage, and remove Teammates, or user accounts, from your SendGrid account. Teammates function like user accounts on the Sen...
The Twilio SendGrid Templates API allows you to create and manage email templates to be delivered with SendGrid's sending APIs. The templates you create will be available using ...
The Twilio SendGrid Tracking Settings API allows you to configure which tracking settings are enabled for your messages. You can track many of your recipients' interactions with...
The Twilio SendGrid User API allows you to modify the settings of a SendGrid user account such as the user's email address or username. Keeping your user profile up to date help...
The Twilio SendGrid Verified Senders API allows you to programmatically manage the Sender Identities that are authorized to send email for your account. You can also manage Send...
The Twilio SendGrid Webhooks API allows you to configure the Event and Parse Webhooks. Email is a data-rich channel, and implementing the Event Webhook will allow you to consume...
Create a campaign, send a test to yourself, and send the campaign for real.
ARAZZO
Create a marketing list, upsert contacts directly into it, and confirm they landed.
ARAZZO
Create a legacy Marketing Campaign targeting lists and schedule it for delivery.
ARAZZO
Create a Single Send draft, schedule it for delivery, and read it back.
ARAZZO
Create a marketing list, build a segment filtered on that list, and refresh it.
ARAZZO
Create a Marketing Campaigns sender and resend its verification when not auto-verified.
ARAZZO
Create a Single Sender identity and check whether sender verification has completed.
ARAZZO
Create a reusable design, create a recipient list, and build a Single Send that uses both.
ARAZZO
Duplicate an existing transactional template and read the new copy back.
ARAZZO
Create a dynamic transactional template, add a version, and send mail using it.
ARAZZO
Add an address to the global suppression list and read it back to confirm.
ARAZZO
Create a list, upsert contacts into it, and branch on the list's contact count.
ARAZZO
Create a segment, manually refresh it, then read it back to inspect its membership.
ARAZZO
Find contacts with an SGQL query and add the matched address to the global suppression list.
ARAZZO
Send a single transactional email and branch on whether it was accepted.
ARAZZO
List Single Sends, branch on whether any exist, and pull aggregate stats for one.
ARAZZO
Create an unsubscribe suppression group, add addresses to it, and list its suppressions.
ARAZZO
Create a template, add a version, activate that version, and read the template back.
ARAZZO
Upsert contacts asynchronously and branch on whether they can be confirmed yet.
ARAZZO
Mail Send v3 API for transactional email
SMTP Relay for legacy app integration
Marketing Campaigns API and UI
Contacts API with custom fields and segments
Email Validation API
Inbound Parse webhook
Free Trial: 100 emails/day for 60 days
Essentials at $19.95/mo for 100k emails
Pro at $89.95/mo for 2.5M emails with dedicated IP
Premier custom pricing with $12k/year minimum
Mail Send rate limit: 100/min Free, 600/min Paid
Subusers for billing and access isolation
SPF, DKIM, DMARC authentication
Activity Feed (3-day Essentials, 7-day Pro)
Send Time Optimization (Pro+)
Tiered IP warm-up service (Premier)
info:
_postman_id: f51bee73-9483-4a84-bfed-97545fc7ca95
name: Twilio SendGrid Webhook Configuration API
description: "The Twilio SendGrid Webhooks API allows you to configure the Event and Parse Webhooks.\n\nEmail is a data-rich\
\ channel, and implementing the Event Webhook will allow you to consume those data in nearly real time. This means you\
\ can actively monitor and participate in the health of your email program throughout the send cycle.\n\nThe Inbound Parse\
\ Webhook processes all incoming email for a domain or subdomain, parses the contents and attachments and then POSTs `multipart/form-data`\
\ to a URL that you choose. \n\nContact Support:\n Name: Twilio SendGrid Support"
schema: https://schema.getpostman.com/json/collection/v2.1.0/collection.json
createdAt: '2026-06-05T15:18:27.000Z'
updatedAt: '2026-06-05T15:18:27.000Z'
lastUpdatedBy: '35240'
uid: 35240-f51bee73-9483-4a84-bfed-97545fc7ca95
item:
- name: v3
item:
- name: user
item:
- name: webhooks
item:
- name: event
item:
- name: settings
item:
- name: all
item:
- name: Retrieve all of your Event Webhooks.
id: c39dbaa9-1a2c-4254-9019-a5d7a1ab83b8
protocolProfileBehavior:
disableBodyPruning: true
request:
method: GET
header:
- description: '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**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of)
for more information.'
key: on-behalf-of
value: <string>
- key: Accept
value: application/json
url:
raw: '{{baseUrl}}/v3/user/webhooks/event/settings/all?include=<string>'
host:
- '{{baseUrl}}'
path:
- v3
- user
- webhooks
- event
- settings
- all
query:
- description: Use this to include optional fields in the response payload. When this is set to `include=account_status_change`,
the `account_status_change` field will be part of the response payload and set to `false` by default.
See [Update an event webhook](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook)
for enabling this webhook notification which lets you subscribe to account status change events related
to compliance action taken by SendGrid.
key: include
value: <string>
description: '**This endpoint allows you to retrieve all of your Event Webhooks.**
Each webhook will be returned as an object in the `webhooks` array with the webhook''s configuration details
and ID. You can use a webhook''s ID to [update the webhook''s settings](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook),
[delete the webhook](https://docs.sendgrid.com/api-reference/webhooks/delete-an-event-webhook), [enable
or disable signature verification for the webhook](https://docs.sendgrid.com/api-reference/webhooks/toggle-signature-verification-for-an-event-webhook),
and, if signature verification is enabled, [retrieve the webhook''s public key](https://docs.sendgrid.com/api-reference/webhooks/get-signed-event-webhooks-public-key)
when signature verification is enabled.
### Event settings
Each webhook''s settings determine which events will be included in the POST request by the webhook and
the URL where the request will be sent. See the [**Event Webhook Reference**](https://docs.sendgrid.com/for-developers/tracking-events/event#delivery-events)
for details about each event type.
### Signature verification
The `public_key` property will be returned only for webhooks with signature verification enabled.
### OAuth
You may share one OAuth configuration across all your webhooks or create unique credentials for each. The
OAuth properties will be returned only for webhooks with OAuth configured.'
response:
- id: 947ecef3-530a-45a7-89b2-469811eef1be
name: Success
originalRequest:
method: GET
header:
- description: '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**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of)
for more information.'
key: on-behalf-of
value: <string>
- key: Accept
value: application/json
- description: 'Added as a part of security scheme: bearer'
key: Authorization
value: Bearer <token>
url:
raw: '{{baseUrl}}/v3/user/webhooks/event/settings/all?include=<string>'
host:
- '{{baseUrl}}'
path:
- v3
- user
- webhooks
- event
- settings
- all
query:
- description: Use this to include optional fields in the response payload. When this is set to `include=account_status_change`,
the `account_status_change` field will be part of the response payload and set to `false` by default.
See [Update an event webhook](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook)
for enabling this webhook notification which lets you subscribe to account status change events related
to compliance action taken by SendGrid.
key: include
value: <string>
status: OK
code: 200
_postman_previewlanguage: json
header:
- key: Content-Type
value: application/json
cookie: []
responseTime: null
body: "{\n \"max_allowed\": \"<number>\",\n \"webhooks\": [\n {\n \"enabled\": \"<boolean>\",\n\
\ \"url\": \"<string>\",\n \"account_status_change\": \"<boolean>\",\n \"group_resubscribe\"\
: \"<boolean>\",\n \"delivered\": \"<boolean>\",\n \"group_unsubscribe\": \"<boolean>\",\n \
\ \"spam_report\": \"<boolean>\",\n \"bounce\": \"<boolean>\",\n \"deferred\": \"<boolean>\"\
,\n \"unsubscribe\": \"<boolean>\",\n \"processed\": \"<boolean>\",\n \"open\": \"<boolean>\"\
,\n \"click\": \"<boolean>\",\n \"dropped\": \"<boolean>\",\n \"friendly_name\": \"<string>\"\
,\n \"id\": \"<string>\",\n \"created_date\": \"<dateTime>\",\n \"updated_date\": \"<dateTime>\"\
,\n \"oauth_client_id\": \"<string>\",\n \"oauth_token_url\": \"<string>\",\n \"public_key\"\
: \"<string>\"\n },\n {\n \"enabled\": \"<boolean>\",\n \"url\": \"<string>\",\n \"\
account_status_change\": \"<boolean>\",\n \"group_resubscribe\": \"<boolean>\",\n \"delivered\"\
: \"<boolean>\",\n \"group_unsubscribe\": \"<boolean>\",\n \"spam_report\": \"<boolean>\",\n \
\ \"bounce\": \"<boolean>\",\n \"deferred\": \"<boolean>\",\n \"unsubscribe\": \"<boolean>\"\
,\n \"processed\": \"<boolean>\",\n \"open\": \"<boolean>\",\n \"click\": \"<boolean>\",\n\
\ \"dropped\": \"<boolean>\",\n \"friendly_name\": \"<string>\",\n \"id\": \"<string>\",\n\
\ \"created_date\": \"<dateTime>\",\n \"updated_date\": \"<dateTime>\",\n \"oauth_client_id\"\
: \"<string>\",\n \"oauth_token_url\": \"<string>\",\n \"public_key\": \"<string>\"\n }\n \
\ ]\n}"
createdAt: '2026-06-05T15:18:27.000Z'
updatedAt: '2026-06-05T15:18:27.000Z'
uid: 35240-947ecef3-530a-45a7-89b2-469811eef1be
createdAt: '2026-06-05T15:18:27.000Z'
updatedAt: '2026-06-05T15:18:27.000Z'
uid: 35240-c39dbaa9-1a2c-4254-9019-a5d7a1ab83b8
id: 8ce69eac-afcd-47b9-ae22-7210d31d3bdd
createdAt: '2026-06-05T15:18:27.000Z'
updatedAt: '2026-06-05T15:18:27.000Z'
uid: 35240-8ce69eac-afcd-47b9-ae22-7210d31d3bdd
- name: signed
item:
- name: '{id}'
item:
- name: Get Signed Event Webhook's Public Key
id: d6079605-b26a-42b1-aa4b-3a66ed4c9ef2
protocolProfileBehavior:
disableBodyPruning: true
request:
method: GET
header:
- description: '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**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of)
for more information.'
key: on-behalf-of
value: <string>
- key: Accept
value: application/json
url:
raw: '{{baseUrl}}/v3/user/webhooks/event/settings/signed/:id'
host:
- '{{baseUrl}}'
path:
- v3
- user
- webhooks
- event
- settings
- signed
- :id
variable:
- id: b425d562-976f-4f1d-aaed-b8dd5151f5d1
key: id
value: <string>
description: (Required) The ID of the Event Webhook you want to retrieve.
description: '**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**](https://docs.sendgrid.com/api-reference/webhooks/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](https://docs.sendgrid.com/api-reference/webhooks/toggle-signature-verification-for-an-event-webhook).
For more information about cryptographically signing the Event Webhook, see [**Getting Started with the
Event Webhook Security Features**](https://sendgrid.com/docs/for-developers/tracking-events/getting-started-event-webhook-security-features).'
response:
- id: 63f742de-f8bf-4d88-9d48-23b878e30d7d
name: Success
originalRequest:
method: GET
header:
- description: '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**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of)
for more information.'
key: on-behalf-of
value: <string>
- key: Accept
value: application/json
- description: 'Added as a part of security scheme: bearer'
key: Authorization
value: Bearer <token>
url:
raw: '{{baseUrl}}/v3/user/webhooks/event/settings/signed/:id'
host:
- '{{baseUrl}}'
path:
- v3
- user
- webhooks
- event
- settings
- signed
- :id
variable:
- key: id
status: OK
code: 200
_postman_previewlanguage: json
header:
- key: Content-Type
value: application/json
cookie: []
responseTime: null
body: "{\n \"id\": \"<string>\",\n \"public_key\": \"<string>\"\n}"
createdAt: '2026-06-05T15:18:27.000Z'
updatedAt: '2026-06-05T15:18:27.000Z'
uid: 35240-63f742de-f8bf-4d88-9d48-23b878e30d7d
- id: 2a33d572-ea20-4a38-b8cb-a807243086bd
name: response
originalRequest:
method: GET
header:
- description: '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**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of)
for more information.'
key: on-behalf-of
value: <string>
- key: Accept
value: application/json
- description: 'Added as a part of security scheme: bearer'
key: Authorization
value: Bearer <token>
url:
raw: '{{baseUrl}}/v3/user/webhooks/event/settings/signed/:id'
host:
- '{{baseUrl}}'
path:
- v3
- user
- webhooks
- event
- settings
- signed
- :id
variable:
- key: id
status: Not Found
code: 404
_postman_previewlanguage: json
header:
- key: Content-Type
value: application/json
cookie: []
responseTime: null
body: "{\n \"errors\": [\n {\n \"message\": \"<string>\"\n },\n {\n \"message\": \"\
<string>\"\n }\n ]\n}"
createdAt: '2026-06-05T15:18:27.000Z'
updatedAt: '2026-06-05T15:18:27.000Z'
uid: 35240-2a33d572-ea20-4a38-b8cb-a807243086bd
createdAt: '2026-06-05T15:18:27.000Z'
updatedAt: '2026-06-05T15:18:27.000Z'
uid: 35240-d6079605-b26a-42b1-aa4b-3a66ed4c9ef2
- name: Toggle signature verification for a single Event Webhook by ID
id: a7e62b8c-7d7d-4fab-87fb-c2889150d449
protocolProfileBehavior:
disableBodyPruning: true
request:
method: PATCH
header:
- description: '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**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of)
for more information.'
key: on-behalf-of
value: <string>
- key: Content-Type
value: application/json
- key: Accept
value: application/json
body:
mode: raw
raw: "{\n \"enabled\": \"<boolean>\"\n}"
options:
raw:
headerFamily: json
language: json
url:
raw: '{{baseUrl}}/v3/user/webhooks/event/settings/signed/:id'
host:
- '{{baseUrl}}'
path:
- v3
- user
- webhooks
- event
- settings
- signed
- :id
variable:
- id: d3027c1d-bf88-4330-96d3-7040572fbc4d
key: id
value: <string>
description: (Required) The ID of the Event Webhook you want to retrieve.
description: '**This endpoint allows you to enable or disable signature verification for a single Event
Webhook by ID.**
If you do not pass a webhook ID to this endpoint, it will enable signature verification for your oldest
webhook by `created_date`. This means the default webhook operated on by this endpoint when no ID is provided
will be the first one you created. This functionality allows customers who do not have multiple webhooks
to enable or disable signature verifiction for their only webhook, even if they do not supply an ID. If
you have multiple webhooks, you can retrieve their IDs using the [**Get All Event Webhooks**](https://docs.sendgrid.com/api-reference/webhooks/get-all-event-webhooks)
endpoint.
This endpoint accepts a single boolean request property, `enabled`, that can be set `true` or `false`
to enable or disable signature verification. This endpoint will return the public key required to verify
Twilio SendGrid signatures if it is enabled or an empty string if signing is disabled. You can also retrieve
your public key using the [**Get an Event Webhook''s Public Key**](https://docs.sendgrid.com/api-reference/webhooks/get-signed-event-webhooks-public-key)
endpoint.
For more information about cryptographically signing the Event Webhook, see [**Getting Started with the
Event Webhook Security Features**](https://sendgrid.com/docs/for-developers/tracking-events/getting-started-event-webhook-security-features).'
response:
- id: c38f8b08-7bcd-4979-9369-8d57b10e3acc
name: Success
originalRequest:
method: PATCH
header:
- description: '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**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of)
for more information.'
key: on-behalf-of
value: <string>
- key: Content-Type
value: application/json
- key: Accept
value: application/json
- description: 'Added as a part of security scheme: bearer'
key: Authorization
value: Bearer <token>
body:
mode: raw
raw: "{\n \"enabled\": \"<boolean>\"\n}"
options:
raw:
headerFamily: json
language: json
url:
raw: '{{baseUrl}}/v3/user/webhooks/event/settings/signed/:id'
host:
- '{{baseUrl}}'
path:
- v3
- user
- webhooks
- event
- settings
- signed
- :id
variable:
- key: id
status: OK
code: 200
_postman_previewlanguage: json
header:
- key: Content-Type
value: application/json
cookie: []
responseTime: null
body: "{\n \"id\": \"<string>\",\n \"public_key\": \"<string>\"\n}"
createdAt: '2026-06-05T15:18:27.000Z'
updatedAt: '2026-06-05T15:18:27.000Z'
uid: 35240-c38f8b08-7bcd-4979-9369-8d57b10e3acc
- id: c1299308-8227-4e43-bc67-2041c379eaaa
name: response
originalRequest:
method: PATCH
header:
- description: '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**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of)
for more information.'
key: on-behalf-of
value: <string>
- key: Content-Type
value: application/json
- key: Accept
value: application/json
- description: 'Added as a part of security scheme: bearer'
key: Authorization
value: Bearer <token>
body:
mode: raw
raw: "{\n \"enabled\": \"<boolean>\"\n}"
options:
raw:
headerFamily: json
language: json
url:
raw: '{{baseUrl}}/v3/user/webhooks/event/settings/signed/:id'
host:
- '{{baseUrl}}'
path:
- v3
- user
- webhooks
- event
- settings
- signed
- :id
variable:
- key: id
status: Not Found
code: 404
_postman_previewlanguage: json
header:
- key: Content-Type
value: application/json
cookie: []
responseTime: null
body: "{\n \"errors\": [\n {\n \"message\": \"<string>\"\n },\n {\n \"message\": \"\
<string>\"\n }\n ]\n}"
createdAt: '2026-06-05T15:18:27.000Z'
updatedAt: '2026-06-05T15:18:27.000Z'
uid: 35240-c1299308-8227-4e43-bc67-2041c379eaaa
createdAt: '2026-06-05T15:18:27.000Z'
updatedAt: '2026-06-05T15:18:27.000Z'
uid: 35240-a7e62b8c-7d7d-4fab-87fb-c2889150d449
id: 4094ff17-a25b-4439-9672-172a9c2e4d56
createdAt: '2026-06-05T15:18:27.000Z'
updatedAt: '2026-06-05T15:18:27.000Z'
uid: 35240-4094ff17-a25b-4439-9672-172a9c2e4d56
id: c1b75f2d-66bd-41b9-8879-2d0a7b22664b
createdAt: '2026-06-05T15:18:27.000Z'
updatedAt: '2026-06-05T15:18:27.000Z'
uid: 35240-c1b75f2d-66bd-41b9-8879-2d0a7b22664b
- name: '{id}'
item:
- name: Get the settings for a single Event Webhook.
id: 14d19e71-5e36-4e56-82b5-f7cd345fabff
protocolProfileBehavior:
disableBodyPruning: true
request:
method: GET
header:
- description: '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**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of)
for more information.'
key: on-behalf-of
value: <string>
- key: Accept
value: application/json
url:
raw: '{{baseUrl}}/v3/user/webhooks/event/settings/:id?include=<string>'
host:
- '{{baseUrl}}'
path:
- v3
- user
- webhooks
- event
- settings
- :id
query:
- description: Use this to include optional fields in the response payload. When this is set to `include=account_status_change`,
the `account_status_change` field will be part of the response payload and set to `false` by default.
See [Update an event webhook](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook)
for enabling this webhook notification which lets you subscribe to account status change events related
to compliance action taken by SendGrid.
key: include
value: <string>
variable:
- id: 03898f93-4184-47e4-9156-2acb166018b8
key: id
value: <string>
description: (Required) The ID of the Event Webhook you want to retrieve.
description: '**This endpoint allows you to retrieve a single Event Webhook by ID.**
If you do not pass a webhook ID to this endpoint, it will return your oldest webhook by `created_date`.
This means the default webhook returned by this endpoint when no ID is provided will be the first one you
created. This functionality allows customers who do not have multiple webhooks to use this endpoint to retrieve
their only webhook, even if they do not supply an ID. If you have multiple webhooks, you can retrieve their
IDs using the [**Get All Event Webhooks**](https://docs.sendgrid.com/api-reference/webhooks/get-all-event-webhooks)
endpoint.
### Event settings
Your webhook will be returned with all of its settings, which include the events that will be included in
the POST request by the webhook and the URL where they will be sent. If an event type is marked as `true`,
t
# --- truncated at 32 KB (192 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sendgrid/refs/heads/main/apis.yml
