Menu

Expand
Rate this page:

Webhooks

Enable/Disable Signed Webhook

PATCH /v3/user/webhooks/event/settings/signed

Base url: https://api.sendgrid.com

This endpoint allows you to enable or disable signing of the Event Webhook.

This endpoint takes a single boolean request parameter, enabled. You may either enable or disable signing of the Event Webhook using this endpoint. Once enabled, you can retrieve your public key using the /webhooks/event/settings/signed endpoint.

For more information about cryptographically signing the Event Webhook, see Getting Started with the Event Webhook Security Features.

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.

Request Body

object
enabled
boolean
required
{
  "enabled": true
}

Responses

object
public_key
string

The public key you can use to verify the Twilio SendGrid signature.

required
object
errors
array[object]
field
string or null
message
string
required
object
errors
array[object]
field
string or null
message
string
required
object
errors
array[object]
field
string or null
message
string
required
        
        
        

        Enable/Disable Signed Webhook

        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.

              
              
              

              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!

              thanks-feedback-gif