SendGrid

Twilio SendGrid Webhook Configuration API

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…

Communication#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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 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.

The 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.

Endpoints 19

Event Webhook

  • POSTCreate a new Event Webhook/v3/user/webhooks/event/settingsThis endpoint allows you to create a new Event Webhook. When creating a webhook, you will provide a URL where you want the webhook to send POST requests, and…
  • GETRetrieve all of your Event Webhooks./v3/user/webhooks/event/settings/all?include=stringThis 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…
  • GETGet Signed Event Webhook's Public Key/v3/user/webhooks/event/settings/signed/:idThis 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…
  • PATCHToggle signature verification for a single Event Webhook by ID/v3/user/webhooks/event/settings/signed/:idThis 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…
  • POSTTest an Event Webhook's settings/v3/user/webhooks/event/testThis endpoint allows you to test an Event Webhook. Retry logic for this endpoint differs from other endpoints, which use a rolling 24-hour retry. This…
  • GETGet the settings for a single Event Webhook./v3/user/webhooks/event/settings/:id?include=stringThis 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…
  • DELETEDelete a single Event Webhook by ID./v3/user/webhooks/event/settings/:idThis endpoint allows you to delete a single Event Webhook by ID. Unlike the Get an Event Webhook and Update an Event Webhook endpoints, which will operate on…
  • PATCHUpdate a single Event Webhook by ID./v3/user/webhooks/event/settings/:id?include=stringThis endpoint allows you to update a single Event Webhook by ID. If you do not pass a webhook ID to this endpoint, it will update and return your oldest…

Parse Webhook

  • GETRetrieve all parse settings/v3/user/webhooks/parse/settingsThis endpoint allows you to retrieve all of your current inbound parse settings.
  • POSTCreate a parse setting/v3/user/webhooks/parse/settingsThis endpoint allows you to create a new inbound parse setting. Creating an Inbound Parse setting requires two pieces of information: a url and a hostname.…
  • GETRetrieve a specific parse setting/v3/user/webhooks/parse/settings/:hostnameThis endpoint allows you to retrieve a specific inbound parse setting by hostname. You can retrieve all your Inbound Parse settings and their associated host…
  • DELETEDelete a parse setting/v3/user/webhooks/parse/settings/:hostnameThis endpoint allows you to delete a specific inbound parse setting by hostname. You can retrieve all your Inbound Parse settings and their associated host…
  • PATCHUpdate a parse setting/v3/user/webhooks/parse/settings/:hostnameThis endpoint allows you to update a specific inbound parse setting by hostname. You can retrieve all your Inbound Parse settings and their associated host…
  • GETRetrieves Inbound Parse Webhook statistics./v3/user/webhooks/parse/stats?limit=string&offset=string&aggregated_by=day&start_date=string&end_date=The day the request is made.This endpoint allows you to retrieve the statistics for your Parse Webhook usage. SendGrid's Inbound Parse Webhook allows you to parse the contents and…

Webhook Security

  • GETRetrieve all webhook security policies for your account/v3/user/webhooks/security/policiesReturns a list of all webhook security policies configured for your account, including their IDs, names, and security configurations.
  • POSTCreate a new webhook security policy/v3/user/webhooks/security/policiesCreate a new webhook security policy. Note: One of signature or oauth must be given to have a valid security policy.
  • GETRetrieve a specific webhook security policy/v3/user/webhooks/security/policies/:idRetrieve the details of a specific webhook security policy by its ID.
  • DELETEDelete a specific webhook security policy/v3/user/webhooks/security/policies/:id?force=truePermanently delete a webhook security policy by its ID.
  • PATCHUpdate an existing webhook security policy/v3/user/webhooks/security/policies/:idUpdate an existing webhook security policy with new configuration values.

API details

Base URL
https://api.sendgrid.com
https://api.eu.sendgrid.com
Authentication
A bearer token in the Authorization header
Operations
19 operations on 10 pathsGET 8POST 4PATCH 4DELETE 3
Main resources
Event Webhook 8Parse Webhook 6Webhook Security 5
Response formats
application/json
Description format
OpenAPI 3.1.0, API version 1.0.0

How to test the Twilio SendGrid Webhook Configuration API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Twilio SendGrid Webhook Configuration API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create a new Event Webhook” (POST /v3/user/webhooks/event/settings), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Twilio SendGrid Webhook Configuration API?

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… It is listed under Communication and has 19 endpoints.

Who publishes the Twilio SendGrid Webhook Configuration API?

It is listed from SendGrid's public API description (an OpenAPI document), not published by SendGrid on Swastik Codes. Anyone who controls sendgrid.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Twilio SendGrid Webhook Configuration API?

Its description lists 2 base URLs: https://api.sendgrid.com, https://api.eu.sendgrid.com. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Twilio SendGrid Webhook Configuration API?

With A bearer token in the Authorization header.

How many endpoints does the Twilio SendGrid Webhook Configuration API have?

19 operations on 10 paths (8 GET, 4 POST, 4 PATCH, 3 DELETE). The largest groups are Event Webhook, Parse Webhook, Webhook Security.

Is forking the Twilio SendGrid Webhook Configuration API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.