Skip to contentSkip to navigationSkip to topbar
On this page

Update a Parse Webhook security policy



API Overview

api-overview page anchor

Twilio SendGrid's Inbound Parse Webhook allows you to receive emails as multipart/form-data at a URL of your choosing. SendGrid will grab the content, attachments, and the headers from any email it receives for your specified hostname.

See "Setting up the Inbound Parse Webhook" for help configuring the Webhook. You can also manage the Inbound Parse Webhook in the Twilio SendGrid App(link takes you to an external page).

To begin processing email using SendGrid's Inbound Parse Webhook, you will have to setup MX Records, choose the hostname (or receiving domain) that will be receiving the emails you want to parse, and define the URL where you want to POST your parsed emails. If you do not have access to your domain's DNS records, you must work with someone in your organization who does.


PATCH/v3/user/webhooks/security/policies/{id}

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

Update an existing webhook security policy with new configuration values.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
authorizationstring
required
Default: Bearer <<YOUR_API_KEY_HERE>>

onBehalfOfstring

Optional

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.

Property nameTypeRequiredDescription
idstring
required
Encoding type:application/json
Schema
Property nameTypeRequiredDescriptionChild properties
namestring

Optional

User-defined policy name


oauthobject

Optional


signatureobject

Optional

200

Success

Schema
Property nameTypeRequiredDescriptionChild properties
policyobject

Optional

Update a Parse Webhook security policyLink to code sample: Update a Parse Webhook security policy
1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const id = "id";
5
const data = {
6
name: "Miss Christine Morgan",
7
};
8
9
const request = {
10
url: `/v3/user/webhooks/security/policies/${id}`,
11
method: "PATCH",
12
body: data,
13
};
14
15
client
16
.request(request)
17
.then(([response, body]) => {
18
console.log(response.statusCode);
19
console.log(response.body);
20
})
21
.catch((error) => {
22
console.error(error);
23
});