Webhooks
Update Event Notification Settings
PATCH /v3/user/webhooks/event/settings
Base url: https://api.sendgrid.com
This endpoint allows you to update your current event webhook settings.
If an event type is marked as true, then the event webhook will include information about that event.
SendGrid’s Event Webhook will notify a URL of your choice via HTTP POST with information about events that occur as SendGrid processes your email.
Common uses of this data are to remove unsubscribes, react to spam reports, determine unengaged recipients, identify bounced email addresses, or create advanced analytics of your email program.
Authentication
- API Key
Headers
Request Body
Indicates if the event webhook is enabled.
The URL that you want the event webhook to POST to.
Recipient resubscribes to specific group by updating preferences. You need to enable Subscription Tracking for getting this type of event.
Message has been successfully delivered to the receiving server.
Recipient unsubscribe from specific group, by either direct link or updating preferences. You need to enable Subscription Tracking for getting this type of event.
Recipient marked a message as spam.
Receiving server could not or would not accept message.
Recipient's email server temporarily rejected message.
Recipient clicked on message's subscription management link. You need to enable Subscription Tracking for getting this type of event.
Message has been received and is ready to be delivered.
Recipient has opened the HTML message. You need to enable Open Tracking for getting this type of event.
Recipient clicked on a link within the message. You need to enable Click Tracking for getting this type of event.
You may see the following drop reasons: Invalid SMTPAPI header, Spam Content (if spam checker app enabled), Unsubscribed Address, Bounced Address, Spam Reporting Address, Invalid, Recipient List over Package Quota
The client ID Twilio SendGrid sends to your OAuth server or service provider to generate an OAuth access token. When passing data in this field, you must also include the oauth_token_url field.
This secret is needed only once to create an access token. SendGrid will store this secret, allowing you to update your Client ID and Token URL without passing the secret to SendGrid again. When passing data in this field, you must also include the oauth_client_id and oauth_token_url fields.
The URL where Twilio SendGrid sends the Client ID and Client Secret to generate an access token. This should be your OAuth server or service provider. When passing data in this field, you must also include the oauth_client_id field.
Responses
Indicates if the event webhook is enabled.
The URL that you want the event webhook to POST to.
Recipient resubscribes to specific group by updating preferences. You need to enable Subscription Tracking for getting this type of event.
Message has been successfully delivered to the receiving server.
Recipient unsubscribe from specific group, by either direct link or updating preferences. You need to enable Subscription Tracking for getting this type of event.
Recipient marked a message as spam.
Receiving server could not or would not accept message.
Recipient's email server temporarily rejected message.
Recipient clicked on message's subscription management link. You need to enable Subscription Tracking for getting this type of event.
Message has been received and is ready to be delivered.
Recipient has opened the HTML message. You need to enable Open Tracking for getting this type of event.
Recipient clicked on a link within the message. You need to enable Click Tracking for getting this type of event.
You may see the following drop reasons: Invalid SMTPAPI header, Spam Content (if spam checker app enabled), Unsubscribed Address, Bounced Address, Spam Reporting Address, Invalid, Recipient List over Package Quota
The client ID Twilio SendGrid sends to your OAuth server or service provider to generate an OAuth access token.
The URL where Twilio SendGrid sends the Client ID and Client Secret to generate an access token. This should be your OAuth server or service provider.
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.
