Menu

Webhooks

Retrieve Event Webhook settings

Retrieve Event Webhook settings

GET /user/webhooks/event/settings

This endpoint allows you to retrieve 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

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.

Responses

object
enabled
boolean

Indicates if the event webhook is enabled.

required
url
string

The URL that you want the event webhook to POST to.

required
group_resubscribe
boolean

Recipient resubscribes to specific group by updating preferences. You need to enable Subscription Tracking for getting this type of event.

required
delivered
boolean

Message has been successfully delivered to the receiving server.

required
group_unsubscribe
boolean

Recipient unsubscribe from specific group, by either direct link or updating preferences. You need to enable Subscription Tracking for getting this type of event.

required
spam_report
boolean

Recipient marked a message as spam.

required
bounce
boolean

Receiving server could not or would not accept message.

required
deferred
boolean

Recipient's email server temporarily rejected message.

required
unsubscribe
boolean

Recipient clicked on message's subscription management link. You need to enable Subscription Tracking for getting this type of event.

required
processed
boolean

Message has been received and is ready to be delivered.

required
open
boolean

Recipient has opened the HTML message. You need to enable Open Tracking for getting this type of event.

required
click
boolean

Recipient clicked on a link within the message. You need to enable Click Tracking for getting this type of event.

required
dropped
boolean

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

required
oauth_client_id
string

The client ID Twilio SendGrid sends to your OAuth server or service provider to generate an OAuth access token.

oauth_token_url
string

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.

Rate this page:

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.

Thank you for your feedback!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Sending your feedback...
🎉 Thank you for your feedback!
Something went wrong. Please try again.

Thanks for your feedback!

Refer us and get $10 in 3 simple steps!

Step 1

Get link

Get a free personal referral link here

Step 2

Give $10

Your user signs up and upgrade using link

Step 3

Get $10

1,250 free SMSes
OR 1,000 free voice mins
OR 12,000 chats
OR more