provider Webhooks PATCH /user/webhooks/event/settings
@utdk/sendgrid /user/webhooks/event/settings
Update Event Notification Settings
**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.
on-behalf-of header
string

Try it

Authentication
Configure credentials for Email Activity (beta)
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

patchUserWebhooksEventSettings
PATCH/user/webhooks/event/settings
**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.

Input

required

Receiving server could not or would not accept message.

required

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

required

Recipient's email server temporarily rejected message.

required

Message has been successfully delivered to the receiving server.

required

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

Indicates if the event webhook is enabled.

required

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

required

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

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.

required

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

required

Message has been received and is ready to be delivered.

required

Recipient marked a message as spam.

required

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

required

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

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import sendgrid from '@utdk/sendgrid';

await sendgrid.patchUserWebhooksEventSettings({
  "on-behalf-of": "The subuser's username. This header generates the API call as if the subuser account was making the call."
})