Menu

Webhooks

Enable/Disable Signed Webhook

Enable/Disable Signed Webhook

PATCH /user/webhooks/event/settings/signed

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
message
string
object
errors
array[object]
field
string
message
string
object
errors
array[object]
field
string
message
string

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.