Rate this page:


Test Event Notification Settings

POST /v3/user/webhooks/event/test

Base url:

This 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 endpoint will make a POST request with a fake event notification to a URL you provide. This allows you to verify that you have properly configured the webhook before sending real data to your URL.

Test OAuth configuration

To test your OAuth configuration, you must include the necessary OAuth properties: oauth_client_id, oauth_client_secret, and oauth_token_url.

If the webhook you are testing already has OAuth credentials saved, you will provide only the oauth_client_id and oauth_token_url—we will pull the secret for you. If you are testing a new set of OAuth credentials that have not been saved with SendGrid, you must provide all three property values.

You can retrieve a previously saved oauth_client_id and oauth_token_url from the Get an Event Webhook endpoint; however, for security reasons, SendGrid will not provide your oauth_client_secret.


  • API Key


default: Bearer <<YOUR_API_KEY_HERE>>

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 for more information.

default: None

Request Body


The ID of the Event Webhook you want to retrieve.


The URL where you would like the test notification to be sent.

string or null

The client ID Twilio SendGrid sends to your OAuth server or service provider to generate an OAuth access token. When passing data in this property, you must also include the oauth_token_url property.

string or null

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

string or null

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

  "id": "77d4a5da-7015-11ed-a1eb-0242ac120002",
  "url": "",
  "oauth_client_id": "a835e7210bbb47edbfa71bdfc909b2d7",
  "oauth_client_secret": "335a9b0c65324fd2a62e2953d4b158",
  "oauth_token_url": ""


No response body.
Loading Code Sample...

        Test Event Notification Settings

        Rate this page:

        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.

        Loading Code Sample...

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

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

              Thanks for your feedback!