{ "info": { "_postman_id": "f51bee73-9483-4a84-bfed-97545fc7ca95", "name": "Twilio SendGrid Webhook Configuration API", "description": "The Twilio SendGrid Webhooks API allows you to configure the Event and Parse Webhooks.\n\nEmail is a data-rich channel, and implementing the Event Webhook will allow you to consume those data in nearly real time. This means you can actively monitor and participate in the health of your email program throughout the send cycle.\n\nThe Inbound Parse Webhook processes all incoming email for a domain or subdomain, parses the contents and attachments and then POSTs `multipart/form-data` to a URL that you choose. \n\nContact Support:\n Name: Twilio SendGrid Support", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "lastUpdatedBy": "35240", "uid": "35240-f51bee73-9483-4a84-bfed-97545fc7ca95" }, "item": [ { "name": "v3", "item": [ { "name": "user", "item": [ { "name": "webhooks", "item": [ { "name": "event", "item": [ { "name": "settings", "item": [ { "name": "all", "item": [ { "name": "Retrieve all of your Event Webhooks.", "id": "c39dbaa9-1a2c-4254-9019-a5d7a1ab83b8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/event/settings/all?include=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "event", "settings", "all" ], "query": [ { "description": "Use this to include optional fields in the response payload. When this is set to `include=account_status_change`, the `account_status_change` field will be part of the response payload and set to `false` by default. See [Update an event webhook](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook) for enabling this webhook notification which lets you subscribe to account status change events related to compliance action taken by SendGrid.", "key": "include", "value": "" } ] }, "description": "**This endpoint allows you to retrieve all of your Event Webhooks.**\n\nEach webhook will be returned as an object in the `webhooks` array with the webhook's configuration details and ID. You can use a webhook's ID to [update the webhook's settings](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook), [delete the webhook](https://docs.sendgrid.com/api-reference/webhooks/delete-an-event-webhook), [enable or disable signature verification for the webhook](https://docs.sendgrid.com/api-reference/webhooks/toggle-signature-verification-for-an-event-webhook), and, if signature verification is enabled, [retrieve the webhook's public key](https://docs.sendgrid.com/api-reference/webhooks/get-signed-event-webhooks-public-key) when signature verification is enabled.\n\n### Event settings\n\nEach webhook's settings determine which events will be included in the POST request by the webhook and the URL where the request will be sent. See the [**Event Webhook Reference**](https://docs.sendgrid.com/for-developers/tracking-events/event#delivery-events) for details about each event type.\n\n### Signature verification\n\nThe `public_key` property will be returned only for webhooks with signature verification enabled.\n\n### OAuth\n\nYou may share one OAuth configuration across all your webhooks or create unique credentials for each. The OAuth properties will be returned only for webhooks with OAuth configured." }, "response": [ { "id": "947ecef3-530a-45a7-89b2-469811eef1be", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/event/settings/all?include=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "event", "settings", "all" ], "query": [ { "description": "Use this to include optional fields in the response payload. When this is set to `include=account_status_change`, the `account_status_change` field will be part of the response payload and set to `false` by default. See [Update an event webhook](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook) for enabling this webhook notification which lets you subscribe to account status change events related to compliance action taken by SendGrid.", "key": "include", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"max_allowed\": \"\",\n \"webhooks\": [\n {\n \"enabled\": \"\",\n \"url\": \"\",\n \"account_status_change\": \"\",\n \"group_resubscribe\": \"\",\n \"delivered\": \"\",\n \"group_unsubscribe\": \"\",\n \"spam_report\": \"\",\n \"bounce\": \"\",\n \"deferred\": \"\",\n \"unsubscribe\": \"\",\n \"processed\": \"\",\n \"open\": \"\",\n \"click\": \"\",\n \"dropped\": \"\",\n \"friendly_name\": \"\",\n \"id\": \"\",\n \"created_date\": \"\",\n \"updated_date\": \"\",\n \"oauth_client_id\": \"\",\n \"oauth_token_url\": \"\",\n \"public_key\": \"\"\n },\n {\n \"enabled\": \"\",\n \"url\": \"\",\n \"account_status_change\": \"\",\n \"group_resubscribe\": \"\",\n \"delivered\": \"\",\n \"group_unsubscribe\": \"\",\n \"spam_report\": \"\",\n \"bounce\": \"\",\n \"deferred\": \"\",\n \"unsubscribe\": \"\",\n \"processed\": \"\",\n \"open\": \"\",\n \"click\": \"\",\n \"dropped\": \"\",\n \"friendly_name\": \"\",\n \"id\": \"\",\n \"created_date\": \"\",\n \"updated_date\": \"\",\n \"oauth_client_id\": \"\",\n \"oauth_token_url\": \"\",\n \"public_key\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-947ecef3-530a-45a7-89b2-469811eef1be" } ], "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-c39dbaa9-1a2c-4254-9019-a5d7a1ab83b8" } ], "id": "8ce69eac-afcd-47b9-ae22-7210d31d3bdd", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-8ce69eac-afcd-47b9-ae22-7210d31d3bdd" }, { "name": "signed", "item": [ { "name": "{id}", "item": [ { "name": "Get Signed Event Webhook's Public Key", "id": "d6079605-b26a-42b1-aa4b-3a66ed4c9ef2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/event/settings/signed/:id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "event", "settings", "signed", ":id" ], "variable": [ { "id": "b425d562-976f-4f1d-aaed-b8dd5151f5d1", "key": "id", "value": "", "description": "(Required) The ID of the Event Webhook you want to retrieve." } ] }, "description": "**This endpoint allows you to retrieve the public key for a single Event Webhook by ID.**\n\nIf you do not pass a webhook ID to this endpoint, it will return the public key for your oldest webhook by `created_date`. This means the default key returned by this endpoint when no ID is provided will be for the first webhook you created. This functionality allows customers who do not have multiple webhooks to use this endpoint to retrieve their only webhook's public key, even if they do not supply an ID. If you have multiple webhooks, you can retrieve their IDs using the [**Get All Event Webhooks**](https://docs.sendgrid.com/api-reference/webhooks/get-all-event-webhooks) endpoint.\n\nOnce you have enabled signature verification for a webhook, you will need the public key provided to verify the signatures on requests coming from Twilio SendGrid. You can use the webhook ID to [enable or disable signature verification with the endpoint dedicated for that operation](https://docs.sendgrid.com/api-reference/webhooks/toggle-signature-verification-for-an-event-webhook).\n\nFor more information about cryptographically signing the Event Webhook, see [**Getting Started with the Event Webhook Security Features**](https://sendgrid.com/docs/for-developers/tracking-events/getting-started-event-webhook-security-features)." }, "response": [ { "id": "63f742de-f8bf-4d88-9d48-23b878e30d7d", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/event/settings/signed/:id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "event", "settings", "signed", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"public_key\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-63f742de-f8bf-4d88-9d48-23b878e30d7d" }, { "id": "2a33d572-ea20-4a38-b8cb-a807243086bd", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/event/settings/signed/:id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "event", "settings", "signed", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-2a33d572-ea20-4a38-b8cb-a807243086bd" } ], "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-d6079605-b26a-42b1-aa4b-3a66ed4c9ef2" }, { "name": "Toggle signature verification for a single Event Webhook by ID", "id": "a7e62b8c-7d7d-4fab-87fb-c2889150d449", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/event/settings/signed/:id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "event", "settings", "signed", ":id" ], "variable": [ { "id": "d3027c1d-bf88-4330-96d3-7040572fbc4d", "key": "id", "value": "", "description": "(Required) The ID of the Event Webhook you want to retrieve." } ] }, "description": "**This endpoint allows you to enable or disable signature verification for a single Event Webhook by ID.**\n\nIf you do not pass a webhook ID to this endpoint, it will enable signature verification for your oldest webhook by `created_date`. This means the default webhook operated on by this endpoint when no ID is provided will be the first one you created. This functionality allows customers who do not have multiple webhooks to enable or disable signature verifiction for their only webhook, even if they do not supply an ID. If you have multiple webhooks, you can retrieve their IDs using the [**Get All Event Webhooks**](https://docs.sendgrid.com/api-reference/webhooks/get-all-event-webhooks) endpoint.\n\nThis endpoint accepts a single boolean request property, `enabled`, that can be set `true` or `false` to enable or disable signature verification. This endpoint will return the public key required to verify Twilio SendGrid signatures if it is enabled or an empty string if signing is disabled. You can also retrieve your public key using the [**Get an Event Webhook's Public Key**](https://docs.sendgrid.com/api-reference/webhooks/get-signed-event-webhooks-public-key) endpoint.\n\nFor more information about cryptographically signing the Event Webhook, see [**Getting Started with the Event Webhook Security Features**](https://sendgrid.com/docs/for-developers/tracking-events/getting-started-event-webhook-security-features)." }, "response": [ { "id": "c38f8b08-7bcd-4979-9369-8d57b10e3acc", "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/event/settings/signed/:id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "event", "settings", "signed", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"public_key\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-c38f8b08-7bcd-4979-9369-8d57b10e3acc" }, { "id": "c1299308-8227-4e43-bc67-2041c379eaaa", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/event/settings/signed/:id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "event", "settings", "signed", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-c1299308-8227-4e43-bc67-2041c379eaaa" } ], "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-a7e62b8c-7d7d-4fab-87fb-c2889150d449" } ], "id": "4094ff17-a25b-4439-9672-172a9c2e4d56", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-4094ff17-a25b-4439-9672-172a9c2e4d56" } ], "id": "c1b75f2d-66bd-41b9-8879-2d0a7b22664b", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-c1b75f2d-66bd-41b9-8879-2d0a7b22664b" }, { "name": "{id}", "item": [ { "name": "Get the settings for a single Event Webhook.", "id": "14d19e71-5e36-4e56-82b5-f7cd345fabff", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/event/settings/:id?include=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "event", "settings", ":id" ], "query": [ { "description": "Use this to include optional fields in the response payload. When this is set to `include=account_status_change`, the `account_status_change` field will be part of the response payload and set to `false` by default. See [Update an event webhook](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook) for enabling this webhook notification which lets you subscribe to account status change events related to compliance action taken by SendGrid.", "key": "include", "value": "" } ], "variable": [ { "id": "03898f93-4184-47e4-9156-2acb166018b8", "key": "id", "value": "", "description": "(Required) The ID of the Event Webhook you want to retrieve." } ] }, "description": "**This endpoint allows you to retrieve a single Event Webhook by ID.**\n\nIf you do not pass a webhook ID to this endpoint, it will return your oldest webhook by `created_date`. This means the default webhook returned by this endpoint when no ID is provided will be the first one you created. This functionality allows customers who do not have multiple webhooks to use this endpoint to retrieve their only webhook, even if they do not supply an ID. If you have multiple webhooks, you can retrieve their IDs using the [**Get All Event Webhooks**](https://docs.sendgrid.com/api-reference/webhooks/get-all-event-webhooks) endpoint.\n\n### Event settings\n\nYour webhook will be returned with all of its settings, which include the events that will be included in the POST request by the webhook and the URL where they will be sent. If an event type is marked as `true`, the event webhook will send information about that event type. See the [**Event Webhook Reference**](https://docs.sendgrid.com/for-developers/tracking-events/event#delivery-events) for details about each event type.\n\n### Signature verification\n\nThe `public_key` property will be returned only for webhooks with signature verification enabled.\n\n### OAuth\n\nYou may share one OAuth configuration across all your webhooks or create unique credentials for each. The OAuth properties will be returned only for webhooks with OAuth configured." }, "response": [ { "id": "fe0d806a-96c5-4d9d-9433-1515877733b7", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/event/settings/:id?include=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "event", "settings", ":id" ], "query": [ { "description": "Use this to include optional fields in the response payload. When this is set to `include=account_status_change`, the `account_status_change` field will be part of the response payload and set to `false` by default. See [Update an event webhook](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook) for enabling this webhook notification which lets you subscribe to account status change events related to compliance action taken by SendGrid.", "key": "include", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"enabled\": \"\",\n \"url\": \"\",\n \"account_status_change\": \"\",\n \"group_resubscribe\": \"\",\n \"delivered\": \"\",\n \"group_unsubscribe\": \"\",\n \"spam_report\": \"\",\n \"bounce\": \"\",\n \"deferred\": \"\",\n \"unsubscribe\": \"\",\n \"processed\": \"\",\n \"open\": \"\",\n \"click\": \"\",\n \"dropped\": \"\",\n \"friendly_name\": \"\",\n \"id\": \"\",\n \"oauth_client_id\": \"\",\n \"oauth_token_url\": \"\",\n \"public_key\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-fe0d806a-96c5-4d9d-9433-1515877733b7" }, { "id": "6f4a103d-609d-489a-818b-5f4ea61a3c6f", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/event/settings/:id?include=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "event", "settings", ":id" ], "query": [ { "description": "Use this to include optional fields in the response payload. When this is set to `include=account_status_change`, the `account_status_change` field will be part of the response payload and set to `false` by default. See [Update an event webhook](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook) for enabling this webhook notification which lets you subscribe to account status change events related to compliance action taken by SendGrid.", "key": "include", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-6f4a103d-609d-489a-818b-5f4ea61a3c6f" } ], "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-14d19e71-5e36-4e56-82b5-f7cd345fabff" }, { "name": "Update a single Event Webhook by ID.", "id": "3d069c05-c989-427f-8e36-38f16064cac3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"enabled\": \"\",\n \"group_resubscribe\": \"\",\n \"delivered\": \"\",\n \"group_unsubscribe\": \"\",\n \"spam_report\": \"\",\n \"bounce\": \"\",\n \"deferred\": \"\",\n \"unsubscribe\": \"\",\n \"processed\": \"\",\n \"open\": \"\",\n \"click\": \"\",\n \"dropped\": \"\",\n \"friendly_name\": \"\",\n \"oauth_client_id\": \"\",\n \"oauth_client_secret\": \"\",\n \"oauth_token_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/event/settings/:id?include=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "event", "settings", ":id" ], "query": [ { "description": "Use this to include optional fields in the response payload. When this is set to `include=account_status_change`, the `account_status_change` field will be part of the response payload and set to `false` by default. See [Update an event webhook](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook) for enabling this webhook notification which lets you subscribe to account status change events related to compliance action taken by SendGrid.", "key": "include", "value": "" } ], "variable": [ { "id": "759b2a06-43cb-4473-9fa5-d12d1a37982e", "key": "id", "value": "", "description": "(Required) The ID of the Event Webhook you want to retrieve." } ] }, "description": "**This endpoint allows you to update a single Event Webhook by ID.**\n\nIf you do not pass a webhook ID to this endpoint, it will update and return your oldest webhook by `created_date`. This means the default webhook updated by this endpoint when no ID is provided will be the first one you created. This functionality allows customers who do not have multiple webhooks to use this endpoint to update their only webhook, even if they do not supply an ID. If you have multiple webhooks, you can retrieve their IDs using the [**Get All Event Webhooks**](https://docs.sendgrid.com/api-reference/webhooks/get-all-event-webhooks) endpoint.\n\n### Enable or disable the webhook\n\nYou can set the `enabled` property to `true` to enable the webhook or `false` to disable it. Disabling a webhook will not delete it from your account, but it will prevent the webhook from sending events to your designated URL.\n\n### URL\n\nA webhook's URL is the endpoint where you want the webhook to send POST requests containing event data. No more than one webhook may be configured to send to the same URL. SendGrid will return an error if you attempt to set a URL for a webhook that is already in use by the user on another webhook.\n\n### Event settings\n\nIf an event type is marked as `true`, the event webhook will send information about that event type. See the [**Event Webhook Reference**](https://docs.sendgrid.com/for-developers/tracking-events/event#delivery-events) for details about each event type.\n\n### Webhook identifiers\n\nYou may assign an optional friendly name to each of your webhooks. The friendly name is for convenience only and should not be used to programmatically differentiate your webhooks because it does not need to be unique.\n\n### OAuth\n\nYou can configure OAuth for your webhook by passing the required values to this endpoint in the `oauth_client_id`, `oauth_client_secret`, and `oauth_token_url` properties. To disable OAuth, pass an empty string to this endpoint for each of the OAuth properties. You may share one OAuth configuration across all your webhooks or create unique credentials for each. See our [webhook security documentation](https://docs.sendgrid.com/for-developers/tracking-events/getting-started-event-webhook-security-features#oauth-20) for more detailed information about OAuth and the Event Webhook.\n\n### Signature verification\n\nEnabling signature verification for your webhook is a separate process and cannot be done with this endpoint. You can use the webhook ID to [enable or disable signature verification with the endpoint dedicated for that operation](https://docs.sendgrid.com/api-reference/webhooks/toggle-signature-verification-for-an-event-webhook)." }, "response": [ { "id": "27b91722-1f56-4fea-bfe3-9b9a12d93723", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"enabled\": \"\",\n \"group_resubscribe\": \"\",\n \"delivered\": \"\",\n \"group_unsubscribe\": \"\",\n \"spam_report\": \"\",\n \"bounce\": \"\",\n \"deferred\": \"\",\n \"unsubscribe\": \"\",\n \"processed\": \"\",\n \"open\": \"\",\n \"click\": \"\",\n \"dropped\": \"\",\n \"friendly_name\": \"\",\n \"oauth_client_id\": \"\",\n \"oauth_client_secret\": \"\",\n \"oauth_token_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/event/settings/:id?include=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "event", "settings", ":id" ], "query": [ { "description": "Use this to include optional fields in the response payload. When this is set to `include=account_status_change`, the `account_status_change` field will be part of the response payload and set to `false` by default. See [Update an event webhook](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook) for enabling this webhook notification which lets you subscribe to account status change events related to compliance action taken by SendGrid.", "key": "include", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"enabled\": \"\",\n \"url\": \"\",\n \"account_status_change\": \"\",\n \"group_resubscribe\": \"\",\n \"delivered\": \"\",\n \"group_unsubscribe\": \"\",\n \"spam_report\": \"\",\n \"bounce\": \"\",\n \"deferred\": \"\",\n \"unsubscribe\": \"\",\n \"processed\": \"\",\n \"open\": \"\",\n \"click\": \"\",\n \"dropped\": \"\",\n \"friendly_name\": \"\",\n \"id\": \"\",\n \"created_date\": \"\",\n \"updated_date\": \"\",\n \"oauth_client_id\": \"\",\n \"oauth_token_url\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-27b91722-1f56-4fea-bfe3-9b9a12d93723" }, { "id": "fe0d8338-bd5e-4562-8b30-4124dccdf488", "name": "Bad request", "originalRequest": { "method": "PATCH", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"enabled\": \"\",\n \"group_resubscribe\": \"\",\n \"delivered\": \"\",\n \"group_unsubscribe\": \"\",\n \"spam_report\": \"\",\n \"bounce\": \"\",\n \"deferred\": \"\",\n \"unsubscribe\": \"\",\n \"processed\": \"\",\n \"open\": \"\",\n \"click\": \"\",\n \"dropped\": \"\",\n \"friendly_name\": \"\",\n \"oauth_client_id\": \"\",\n \"oauth_client_secret\": \"\",\n \"oauth_token_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/event/settings/:id?include=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "event", "settings", ":id" ], "query": [ { "description": "Use this to include optional fields in the response payload. When this is set to `include=account_status_change`, the `account_status_change` field will be part of the response payload and set to `false` by default. See [Update an event webhook](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook) for enabling this webhook notification which lets you subscribe to account status change events related to compliance action taken by SendGrid.", "key": "include", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"url\": \"\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"url\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-fe0d8338-bd5e-4562-8b30-4124dccdf488" }, { "id": "b0238248-13ff-4409-94b1-6e89302011ee", "name": "Not found", "originalRequest": { "method": "PATCH", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"enabled\": \"\",\n \"group_resubscribe\": \"\",\n \"delivered\": \"\",\n \"group_unsubscribe\": \"\",\n \"spam_report\": \"\",\n \"bounce\": \"\",\n \"deferred\": \"\",\n \"unsubscribe\": \"\",\n \"processed\": \"\",\n \"open\": \"\",\n \"click\": \"\",\n \"dropped\": \"\",\n \"friendly_name\": \"\",\n \"oauth_client_id\": \"\",\n \"oauth_client_secret\": \"\",\n \"oauth_token_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/event/settings/:id?include=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "event", "settings", ":id" ], "query": [ { "description": "Use this to include optional fields in the response payload. When this is set to `include=account_status_change`, the `account_status_change` field will be part of the response payload and set to `false` by default. See [Update an event webhook](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook) for enabling this webhook notification which lets you subscribe to account status change events related to compliance action taken by SendGrid.", "key": "include", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-b0238248-13ff-4409-94b1-6e89302011ee" } ], "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-3d069c05-c989-427f-8e36-38f16064cac3" }, { "name": "Delete a single Event Webhook by ID.", "id": "c1cbfb17-6f51-41fa-8334-0bc0a20addf6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/event/settings/:id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "event", "settings", ":id" ], "variable": [ { "id": "4346e98b-9f4f-48b0-a3cf-ceb9e6b18fc3", "key": "id", "value": "", "description": "(Required) The ID of the Event Webhook you want to retrieve." } ] }, "description": "**This endpoint allows you to delete a single Event Webhook by ID.**\n\nUnlike the [**Get an Event Webhook**](https://docs.sendgrid.com/api-reference/webhooks/get-an-event-webhook) and [**Update an Event Webhook**](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook) endpoints, which will operate on your oldest webhook by `created_date` when you don't provide an ID, this endpoint will return an error if you do not pass it an ID. This behavior prevents customers from unintentionally deleting a webhook. You can retrieve your webhooks' IDs using the [**Get All Event Webhooks**](https://docs.sendgrid.com/api-reference/webhooks/get-all-event-webhooks) endpoint.\n\n### Enable or disable the webhook\n\nThis endpoint will permanently delete the webhook specified. If you instead want to disable a webhook, you can set the `enabled` property to `false` with the [**Update an Event Webhook**](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook) endpoint." }, "response": [ { "id": "12e7c4d8-3dfd-492d-8dec-c4091cf5c854", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/event/settings/:id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "event", "settings", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-12e7c4d8-3dfd-492d-8dec-c4091cf5c854" }, { "id": "cc622e4b-d5c2-4477-a371-f7095d0fb3bd", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/event/settings/:id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "event", "settings", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-cc622e4b-d5c2-4477-a371-f7095d0fb3bd" } ], "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-c1cbfb17-6f51-41fa-8334-0bc0a20addf6" } ], "id": "a3b5768a-83fb-472b-85bc-1d7e0a6452b5", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-a3b5768a-83fb-472b-85bc-1d7e0a6452b5" }, { "name": "Create a new Event Webhook", "id": "21ce822b-7449-4aef-8dcb-3f9cdffd0aec", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"enabled\": \"\",\n \"group_resubscribe\": \"\",\n \"delivered\": \"\",\n \"group_unsubscribe\": \"\",\n \"spam_report\": \"\",\n \"bounce\": \"\",\n \"deferred\": \"\",\n \"unsubscribe\": \"\",\n \"processed\": \"\",\n \"open\": \"\",\n \"click\": \"\",\n \"dropped\": \"\",\n \"friendly_name\": \"\",\n \"oauth_client_id\": \"\",\n \"oauth_client_secret\": \"\",\n \"oauth_token_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/event/settings", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "event", "settings" ] }, "description": "**This endpoint allows you to create a new Event Webhook.**\n\nWhen creating a webhook, you will provide a URL where you want the webhook to send POST requests, and you will select which events you want to receive in those request. See the [**Event Webhook Reference**](https://docs.sendgrid.com/for-developers/tracking-events/event#delivery-events) for details about each event type.\n\n### Webhook identifiers\n\nWhen your webhook is succesfully created, you will receive a webhook `id` in the response returned by this endpoint. You can use that ID to [update the webhook's settings](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook), [delete the webhook](https://docs.sendgrid.com/api-reference/webhooks/delete-an-event-webhook), [enable or disable signature verification for the webhook](https://docs.sendgrid.com/api-reference/webhooks/toggle-signature-verification-for-an-event-webhook), and, if signature verification is enabled, [retrieve the webhook's public key](https://docs.sendgrid.com/api-reference/webhooks/get-signed-event-webhooks-public-key).\n\nYou may also assign an optional friendly name to each of your webhooks. The friendly name is for convenience only and should not be used to programmatically differentiate your webhooks because it does not need to be unique. Use the webhook ID to reliably differentiate among your webhooks.\n\n### OAuth\n\nYou can optionally configure OAuth verification for your webhook at the time of creation by passing the appropriate values in the `oauth_client_id`, `oauth_client_secret`, and `oauth_token_url` properties. You can enable or disable OAuth for the webhook after creation with the [**Update an Event Webhook**](https://docs.sendgrid.com/api-reference/webhooks/update-an-event-webhook) operation.\n\nYou may share one OAuth configuration across all your webhooks or create unique credentials for each. See our [webhook security documentation](https://docs.sendgrid.com/for-developers/tracking-events/getting-started-event-webhook-security-features#oauth-20) for details about OAuth and the Event Webhook.\n\n### Signature verification\n\nEnabling signature verification for your webhook is a separate process and cannot be done at the time of creation with this endpoint. You can use the webhook ID to [enable or disable signature verification with the endpoint dedicated for that operation](https://docs.sendgrid.com/api-reference/webhooks/toggle-signature-verification-for-an-event-webhook)." }, "response": [ { "id": "ae5c18bf-5705-47ed-9fee-044f9806614d", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"enabled\": \"\",\n \"group_resubscribe\": \"\",\n \"delivered\": \"\",\n \"group_unsubscribe\": \"\",\n \"spam_report\": \"\",\n \"bounce\": \"\",\n \"deferred\": \"\",\n \"unsubscribe\": \"\",\n \"processed\": \"\",\n \"open\": \"\",\n \"click\": \"\",\n \"dropped\": \"\",\n \"friendly_name\": \"\",\n \"oauth_client_id\": \"\",\n \"oauth_client_secret\": \"\",\n \"oauth_token_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/event/settings", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "event", "settings" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"enabled\": \"\",\n \"url\": \"\",\n \"account_status_change\": \"\",\n \"group_resubscribe\": \"\",\n \"delivered\": \"\",\n \"group_unsubscribe\": \"\",\n \"spam_report\": \"\",\n \"bounce\": \"\",\n \"deferred\": \"\",\n \"unsubscribe\": \"\",\n \"processed\": \"\",\n \"open\": \"\",\n \"click\": \"\",\n \"dropped\": \"\",\n \"friendly_name\": \"\",\n \"id\": \"\",\n \"created_date\": \"\",\n \"updated_date\": \"\",\n \"oauth_client_id\": \"\",\n \"oauth_token_url\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-ae5c18bf-5705-47ed-9fee-044f9806614d" }, { "id": "bacc63b8-08c8-401d-be51-11a9c4051ff7", "name": "Bad request", "originalRequest": { "method": "POST", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"enabled\": \"\",\n \"group_resubscribe\": \"\",\n \"delivered\": \"\",\n \"group_unsubscribe\": \"\",\n \"spam_report\": \"\",\n \"bounce\": \"\",\n \"deferred\": \"\",\n \"unsubscribe\": \"\",\n \"processed\": \"\",\n \"open\": \"\",\n \"click\": \"\",\n \"dropped\": \"\",\n \"friendly_name\": \"\",\n \"oauth_client_id\": \"\",\n \"oauth_client_secret\": \"\",\n \"oauth_token_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/event/settings", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "event", "settings" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"id\": \"\",\n \"message\": \"\",\n \"url\": \"\"\n },\n {\n \"id\": \"\",\n \"message\": \"\",\n \"url\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-bacc63b8-08c8-401d-be51-11a9c4051ff7" } ], "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-21ce822b-7449-4aef-8dcb-3f9cdffd0aec" } ], "id": "e2392a53-cbaa-484d-b7af-6a2f2a53a120", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-e2392a53-cbaa-484d-b7af-6a2f2a53a120" }, { "name": "test", "item": [ { "name": "Test an Event Webhook's settings", "id": "aa2513d2-e64d-4288-ab71-4d3aaedec83e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"id\": \"\",\n \"oauth_client_id\": \"\",\n \"oauth_client_secret\": \"\",\n \"oauth_token_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/event/test", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "event", "test" ] }, "description": "**This endpoint allows you to test an Event Webhook.**\n\nRetry logic for this endpoint differs from other endpoints, which use a rolling 24-hour retry.\n\nThis 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.\n\n### Test OAuth configuration\n\nTo test your OAuth configuration, you must include the necessary OAuth properties: `oauth_client_id`, `oauth_client_secret`, and `oauth_token_url`.\n\nIf the webhook you are testing already has OAuth credentials saved, you will provide only the `oauth_client_id` and `oauth_token_url`\u2014we 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.\n\nYou can retrieve a previously saved `oauth_client_id` and `oauth_token_url` from the [**Get an Event Webhook**](https://docs.sendgrid.com/api-reference/webhooks/get-an-event-webhook) endpoint; however, for security reasons, SendGrid will not provide your `oauth_client_secret`." }, "response": [ { "id": "265c65e3-5ba2-4f62-a3bf-cbca80bf7d92", "name": "No Content", "originalRequest": { "method": "POST", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"id\": \"\",\n \"oauth_client_id\": \"\",\n \"oauth_client_secret\": \"\",\n \"oauth_token_url\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/event/test", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "event", "test" ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-265c65e3-5ba2-4f62-a3bf-cbca80bf7d92" } ], "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-aa2513d2-e64d-4288-ab71-4d3aaedec83e" } ], "id": "a1767f10-d745-4aaf-a7e3-4cf3e45b4d38", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-a1767f10-d745-4aaf-a7e3-4cf3e45b4d38" } ], "id": "1e5ecf3c-afdd-4379-a8a1-e5eb4b501694", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-1e5ecf3c-afdd-4379-a8a1-e5eb4b501694" }, { "name": "parse", "item": [ { "name": "settings", "item": [ { "name": "{hostname}", "item": [ { "name": "Retrieve a specific parse setting", "id": "7b5249a9-74c9-460e-90e6-f876a2694084", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings/:hostname", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings", ":hostname" ], "variable": [ { "id": "8f56277b-f836-45ff-92f4-8fc3abea8de3", "key": "hostname", "value": "", "description": "(Required) The hostname associated with the inbound parse setting that you would like to retrieve." } ] }, "description": "**This endpoint allows you to retrieve a specific inbound parse setting by hostname.**\n\nYou can retrieve all your Inbound Parse settings and their associated host names with the \"Retrieve all parse settings\" endpoint." }, "response": [ { "id": "18bd594b-04cd-48a8-a83d-9d0c8928d85d", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings/:hostname", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings", ":hostname" ], "variable": [ { "key": "hostname" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"url\": \"\",\n \"hostname\": \"\",\n \"spam_check\": \"\",\n \"send_raw\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-18bd594b-04cd-48a8-a83d-9d0c8928d85d" }, { "id": "6851405c-c3ce-4301-ab8f-844495f01e7a", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings/:hostname", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings", ":hostname" ], "variable": [ { "key": "hostname" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-6851405c-c3ce-4301-ab8f-844495f01e7a" }, { "id": "338aa290-968d-4c89-9301-b2e5b46384ba", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings/:hostname", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings", ":hostname" ], "variable": [ { "key": "hostname" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-338aa290-968d-4c89-9301-b2e5b46384ba" }, { "id": "3806ff09-a7fa-4c23-ae86-6d469c32c710", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings/:hostname", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings", ":hostname" ], "variable": [ { "key": "hostname" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-3806ff09-a7fa-4c23-ae86-6d469c32c710" }, { "id": "7e663aff-0ebd-4119-acf8-63c726a6ac42", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings/:hostname", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings", ":hostname" ], "variable": [ { "key": "hostname" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-7e663aff-0ebd-4119-acf8-63c726a6ac42" } ], "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-7b5249a9-74c9-460e-90e6-f876a2694084" }, { "name": "Update a parse setting", "id": "2ae411b1-167e-41dd-baeb-9d7b5c1a4748", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"hostname\": \"\",\n \"spam_check\": \"\",\n \"send_raw\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings/:hostname", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings", ":hostname" ], "variable": [ { "id": "d37a593a-dbfb-4761-af79-7d742085bd03", "key": "hostname", "value": "", "description": "(Required) The hostname associated with the inbound parse setting that you would like to retrieve." } ] }, "description": "**This endpoint allows you to update a specific inbound parse setting by hostname.**\n\nYou can retrieve all your Inbound Parse settings and their associated host names with the \"Retrieve all parse settings\" endpoint." }, "response": [ { "id": "0ffde1d7-cdec-4f2f-ad8b-136fe480b8f7", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"hostname\": \"\",\n \"spam_check\": \"\",\n \"send_raw\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings/:hostname", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings", ":hostname" ], "variable": [ { "key": "hostname" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"url\": \"\",\n \"hostname\": \"\",\n \"spam_check\": \"\",\n \"send_raw\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-0ffde1d7-cdec-4f2f-ad8b-136fe480b8f7" }, { "id": "f3c1fe9c-28b2-4603-bc01-3cbefb60fbdb", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"hostname\": \"\",\n \"spam_check\": \"\",\n \"send_raw\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings/:hostname", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings", ":hostname" ], "variable": [ { "key": "hostname" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-f3c1fe9c-28b2-4603-bc01-3cbefb60fbdb" }, { "id": "bd381726-c82e-44f5-9d30-f41c6f6b2049", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"hostname\": \"\",\n \"spam_check\": \"\",\n \"send_raw\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings/:hostname", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings", ":hostname" ], "variable": [ { "key": "hostname" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-bd381726-c82e-44f5-9d30-f41c6f6b2049" }, { "id": "1871d190-e1a7-49cf-82c5-a9738118982e", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"hostname\": \"\",\n \"spam_check\": \"\",\n \"send_raw\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings/:hostname", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings", ":hostname" ], "variable": [ { "key": "hostname" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-1871d190-e1a7-49cf-82c5-a9738118982e" }, { "id": "e29932cd-375f-411b-b8a7-7251c264c04c", "name": "response", "originalRequest": { "method": "PATCH", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"hostname\": \"\",\n \"spam_check\": \"\",\n \"send_raw\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings/:hostname", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings", ":hostname" ], "variable": [ { "key": "hostname" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-e29932cd-375f-411b-b8a7-7251c264c04c" } ], "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-2ae411b1-167e-41dd-baeb-9d7b5c1a4748" }, { "name": "Delete a parse setting", "id": "cfb20ab9-2a98-4d1a-92a2-22536719e50f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings/:hostname", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings", ":hostname" ], "variable": [ { "id": "29a5a933-7fb8-471e-a22c-cfc3c3a9d4b9", "key": "hostname", "value": "", "description": "(Required) The hostname associated with the inbound parse setting that you would like to retrieve." } ] }, "description": "**This endpoint allows you to delete a specific inbound parse setting by hostname.**\n\nYou can retrieve all your Inbound Parse settings and their associated host names with the \"Retrieve all parse settings\" endpoint." }, "response": [ { "id": "0e1c9961-8908-4f97-a77e-a47b4287375e", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings/:hostname", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings", ":hostname" ], "variable": [ { "key": "hostname" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-0e1c9961-8908-4f97-a77e-a47b4287375e" }, { "id": "2ca57963-e18e-4120-aab5-00e37031647a", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings/:hostname", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings", ":hostname" ], "variable": [ { "key": "hostname" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-2ca57963-e18e-4120-aab5-00e37031647a" }, { "id": "7ea9028e-cbad-47e1-83fb-44ec61ff17b0", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings/:hostname", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings", ":hostname" ], "variable": [ { "key": "hostname" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-7ea9028e-cbad-47e1-83fb-44ec61ff17b0" }, { "id": "c21414d0-fb8c-4639-ae76-be115b0f180e", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings/:hostname", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings", ":hostname" ], "variable": [ { "key": "hostname" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-c21414d0-fb8c-4639-ae76-be115b0f180e" }, { "id": "2a6738d3-567c-49af-a4e2-34448d302e80", "name": "response", "originalRequest": { "method": "DELETE", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings/:hostname", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings", ":hostname" ], "variable": [ { "key": "hostname" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-2a6738d3-567c-49af-a4e2-34448d302e80" } ], "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-cfb20ab9-2a98-4d1a-92a2-22536719e50f" } ], "id": "3ac133f2-42a3-4818-ad44-52ff8468240b", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-3ac133f2-42a3-4818-ad44-52ff8468240b" }, { "name": "Retrieve all parse settings", "id": "631c3a1e-030c-43c9-9aaf-18ff7ca875d7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings" ] }, "description": "**This endpoint allows you to retrieve all of your current inbound parse settings.**" }, "response": [ { "id": "bbc15464-9c11-4818-8c34-209f0f7a51c0", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"result\": [\n {\n \"url\": \"\",\n \"hostname\": \"\",\n \"spam_check\": \"\",\n \"send_raw\": \"\"\n },\n {\n \"url\": \"\",\n \"hostname\": \"\",\n \"spam_check\": \"\",\n \"send_raw\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-bbc15464-9c11-4818-8c34-209f0f7a51c0" }, { "id": "5bf4b3d0-b55a-466c-a703-1faba2764a1c", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-5bf4b3d0-b55a-466c-a703-1faba2764a1c" }, { "id": "0931e769-6c84-414c-8a6b-e587d144dec3", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-0931e769-6c84-414c-8a6b-e587d144dec3" }, { "id": "d3d51109-ba52-4df4-8ded-7868e064ccd6", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-d3d51109-ba52-4df4-8ded-7868e064ccd6" }, { "id": "ee813d23-9c7d-436d-9f3a-01aacba4c9f2", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-ee813d23-9c7d-436d-9f3a-01aacba4c9f2" } ], "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-631c3a1e-030c-43c9-9aaf-18ff7ca875d7" }, { "name": "Create a parse setting", "id": "57e34066-e967-4d32-b1e9-57877e144902", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"hostname\": \"\",\n \"spam_check\": \"\",\n \"send_raw\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings" ] }, "description": "**This endpoint allows you to create a new inbound parse setting.**\n\nCreating an Inbound Parse setting requires two pieces of information: a `url` and a `hostname`.\n\nThe `hostname` must correspond to a domain authenticated by Twilio SendGrid on your account. If you need to complete domain authentication, you can use the [Twilio SendGrid App](https://app.sendgrid.com/settings/sender_auth) or the **Authenticate a Domain** endpoint. See [**How to Set Up Domain Authentication**](https://sendgrid.com/docs/ui/account-and-settings/how-to-set-up-domain-authentication/) for instructions.\n\nAny email received by the `hostname` will be parsed when you complete this setup. You must also add a Twilio SendGrid MX record to this domain's DNS records. See [**Setting up the Inbound Parse Webhook**](https://sendgrid.com/docs/for-developers/parsing-email/setting-up-the-inbound-parse-webhook/) for full instructions.\n\nThe `url` represents a location where the parsed message data will be delivered. Twilio SendGrid will make an HTTP POST request to this `url` with the message data. The `url` must be publicly reachable, and your application must return a `200` status code to signal that the message data has been received." }, "response": [ { "id": "eb357b8b-e8b2-45a8-bda8-bc67e774956f", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"hostname\": \"\",\n \"spam_check\": \"\",\n \"send_raw\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"url\": \"\",\n \"hostname\": \"\",\n \"spam_check\": \"\",\n \"send_raw\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-eb357b8b-e8b2-45a8-bda8-bc67e774956f" }, { "id": "2404d8fe-f6e1-4bbc-a69d-6a76a05af38f", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"hostname\": \"\",\n \"spam_check\": \"\",\n \"send_raw\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-2404d8fe-f6e1-4bbc-a69d-6a76a05af38f" }, { "id": "9f224070-75ea-43f7-abf6-873b1fc619c2", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"hostname\": \"\",\n \"spam_check\": \"\",\n \"send_raw\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-9f224070-75ea-43f7-abf6-873b1fc619c2" }, { "id": "ee33f7e3-a9f9-407e-968f-4df163d0f29d", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"hostname\": \"\",\n \"spam_check\": \"\",\n \"send_raw\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings" ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n },\n {\n \"message\": \"\",\n \"field\": \"\",\n \"help\": {}\n }\n ],\n \"id\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-ee33f7e3-a9f9-407e-968f-4df163d0f29d" }, { "id": "dd5e172e-8f89-48ea-8176-ada700e86586", "name": "response", "originalRequest": { "method": "POST", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"hostname\": \"\",\n \"spam_check\": \"\",\n \"send_raw\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/settings", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "settings" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"message\": \"\"\n },\n {\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-dd5e172e-8f89-48ea-8176-ada700e86586" } ], "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-57e34066-e967-4d32-b1e9-57877e144902" } ], "id": "e696149d-7881-4333-937b-ac0e4d2f0140", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-e696149d-7881-4333-937b-ac0e4d2f0140" }, { "name": "stats", "item": [ { "name": "Retrieves Inbound Parse Webhook statistics.", "id": "f8d18bdc-0b14-42c5-a41c-e3d9db317ed8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/stats?limit=&offset=&aggregated_by=week&start_date=&end_date=The day the request is made.", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "stats" ], "query": [ { "description": "The number of statistics to return on each page.", "key": "limit", "value": "" }, { "description": "The number of statistics to skip.", "key": "offset", "value": "" }, { "description": "How you would like the statistics to by grouped. ", "key": "aggregated_by", "value": "week" }, { "description": "(Required) The starting date of the statistics you want to retrieve. Must be in the format YYYY-MM-DD", "key": "start_date", "value": "" }, { "description": "The end date of the statistics you want to retrieve. Must be in the format YYYY-MM-DD", "key": "end_date", "value": "The day the request is made." } ] }, "description": "**This endpoint allows you to retrieve the statistics for your Parse Webhook usage.**\n\nSendGrid's Inbound Parse Webhook allows you to parse the contents and attachments of incoming emails. The Parse API can then POST the parsed emails to a URL that you specify. The Inbound Parse Webhook cannot parse messages greater than 30MB in size, including all attachments.\n\nThere are a number of pre-made integrations for the SendGrid Parse Webhook which make processing events easy. You can find these integrations in the [Library Index](https://docs.sendgrid.com/for-developers/sending-email/libraries#webhook-libraries)." }, "response": [ { "id": "3f3d4a42-31ec-4614-90e2-2188748c171a", "name": "response", "originalRequest": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/parse/stats?limit=&offset=&aggregated_by=week&start_date=&end_date=The day the request is made.", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "parse", "stats" ], "query": [ { "description": "The number of statistics to return on each page.", "key": "limit", "value": "" }, { "description": "The number of statistics to skip.", "key": "offset", "value": "" }, { "description": "How you would like the statistics to by grouped. ", "key": "aggregated_by", "value": "week" }, { "description": "(Required) The starting date of the statistics you want to retrieve. Must be in the format YYYY-MM-DD", "key": "start_date", "value": "" }, { "description": "The end date of the statistics you want to retrieve. Must be in the format YYYY-MM-DD", "key": "end_date", "value": "The day the request is made." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "[\n {\n \"date\": \"\",\n \"stats\": [\n {\n \"metrics\": {\n \"received\": \"\"\n }\n },\n {\n \"metrics\": {\n \"received\": \"\"\n }\n }\n ]\n },\n {\n \"date\": \"\",\n \"stats\": [\n {\n \"metrics\": {\n \"received\": \"\"\n }\n },\n {\n \"metrics\": {\n \"received\": \"\"\n }\n }\n ]\n }\n]", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-3f3d4a42-31ec-4614-90e2-2188748c171a" } ], "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-f8d18bdc-0b14-42c5-a41c-e3d9db317ed8" } ], "id": "acd43914-1d08-4216-a3f6-08cc45ed03a1", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-acd43914-1d08-4216-a3f6-08cc45ed03a1" } ], "id": "15bcce59-ba05-4060-8bd1-b8389e539502", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-15bcce59-ba05-4060-8bd1-b8389e539502" }, { "name": "security", "item": [ { "name": "policies", "item": [ { "name": "{id}", "item": [ { "name": "Update an existing webhook security policy", "id": "d33ac861-0736-4142-9a5f-d648726d83d1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"oauth\": {\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"token_url\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n },\n \"signature\": {\n \"enabled\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/security/policies/:id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "security", "policies", ":id" ], "variable": [ { "id": "a775f217-77cf-489e-a4b4-39c6c3ff194b", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Update an existing webhook security policy with new configuration values." }, "response": [ { "id": "b56b8361-7c40-4e86-b437-9463393aaa83", "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"oauth\": {\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"token_url\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n },\n \"signature\": {\n \"enabled\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/security/policies/:id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "security", "policies", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"policy\": {\n \"id\": \"\",\n \"name\": \"\",\n \"oauth\": {\n \"client_id\": \"\",\n \"token_url\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n }\n }\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-b56b8361-7c40-4e86-b437-9463393aaa83" } ], "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-d33ac861-0736-4142-9a5f-d648726d83d1" }, { "name": "Retrieve a specific webhook security policy", "id": "19142d97-1638-47fc-8afa-3d6367a6388b", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/security/policies/:id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "security", "policies", ":id" ], "variable": [ { "id": "5a7f8aaf-de3c-4d55-89a7-abd2ed98168c", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Retrieve the details of a specific webhook security policy by its ID." }, "response": [ { "id": "16135925-5f89-4af2-a322-295b8e78b2e3", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/security/policies/:id", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "security", "policies", ":id" ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"policy\": {\n \"id\": \"\",\n \"name\": \"\",\n \"oauth\": {\n \"client_id\": \"\",\n \"token_url\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n },\n \"signature\": {\n \"public_key\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-16135925-5f89-4af2-a322-295b8e78b2e3" } ], "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-19142d97-1638-47fc-8afa-3d6367a6388b" }, { "name": "Delete a specific webhook security policy", "id": "621703a7-1f75-4125-beec-616ffed9bc65", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/security/policies/:id?force=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "security", "policies", ":id" ], "query": [ { "key": "force", "value": "" } ], "variable": [ { "id": "be034fa0-8fcf-4fcb-ad4b-4675d6cf895a", "key": "id", "value": "", "description": "(Required) " } ] }, "description": "Permanently delete a webhook security policy by its ID." }, "response": [ { "id": "5c9b8b59-14f9-41ed-b82d-2bf7ba786fe2", "name": "Success", "originalRequest": { "method": "DELETE", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/security/policies/:id?force=", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "security", "policies", ":id" ], "query": [ { "key": "force", "value": "" } ], "variable": [ { "key": "id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"policy\": \"\"\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-5c9b8b59-14f9-41ed-b82d-2bf7ba786fe2" } ], "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-621703a7-1f75-4125-beec-616ffed9bc65" } ], "id": "af7b09f6-4e52-41f7-af1d-fc1e79a246ab", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-af7b09f6-4e52-41f7-af1d-fc1e79a246ab" }, { "name": "Create a new webhook security policy", "id": "96400829-065d-452e-b02e-a4749f4e9fed", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"oauth\": {\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"token_url\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n },\n \"signature\": {\n \"enabled\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/security/policies", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "security", "policies" ] }, "description": "Create a new webhook security policy. Note: One of signature or oauth must be given to have a valid security policy.\n" }, "response": [ { "id": "88b78d77-2917-4aaa-b64b-17db92c827f2", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"oauth\": {\n \"client_id\": \"\",\n \"client_secret\": \"\",\n \"token_url\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n },\n \"signature\": {\n \"enabled\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v3/user/webhooks/security/policies", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "security", "policies" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"policy\": {\n \"id\": \"\",\n \"name\": \"\",\n \"oauth\": {\n \"client_id\": \"\",\n \"token_url\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n },\n \"signature\": {\n \"public_key\": \"\"\n }\n }\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-88b78d77-2917-4aaa-b64b-17db92c827f2" } ], "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-96400829-065d-452e-b02e-a4749f4e9fed" }, { "name": "Retrieve all webhook security policies for your account", "id": "8eef72a8-e520-4d2d-9ff9-da8ffe2b4a35", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/security/policies", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "security", "policies" ] }, "description": "Returns a list of all webhook security policies configured for your account, including their IDs, names, and security configurations." }, "response": [ { "id": "77491bf3-3a59-4a24-9aa4-b58c7794b5f5", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "description": "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 `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](https://docs.sendgrid.com/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.", "key": "on-behalf-of", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v3/user/webhooks/security/policies", "host": [ "{{baseUrl}}" ], "path": [ "v3", "user", "webhooks", "security", "policies" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"policies\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"oauth\": {\n \"client_id\": \"\",\n \"token_url\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n },\n \"signature\": {\n \"public_key\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"oauth\": {\n \"client_id\": \"\",\n \"token_url\": \"\",\n \"scopes\": [\n \"\",\n \"\"\n ]\n },\n \"signature\": {\n \"public_key\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-77491bf3-3a59-4a24-9aa4-b58c7794b5f5" } ], "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-8eef72a8-e520-4d2d-9ff9-da8ffe2b4a35" } ], "id": "d7164209-185c-4b5d-bb92-9930aeaff223", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-d7164209-185c-4b5d-bb92-9930aeaff223" } ], "id": "76c838f1-5c38-4253-94df-8cf018ef4cb5", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-76c838f1-5c38-4253-94df-8cf018ef4cb5" } ], "id": "1d035a3a-c968-472f-b85f-4692ba6b2b76", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-1d035a3a-c968-472f-b85f-4692ba6b2b76" } ], "id": "73e623fa-831d-4f35-bd0e-60f479c294a7", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-73e623fa-831d-4f35-bd0e-60f479c294a7" } ], "id": "2cc2d391-7724-4059-935c-ffdc8c03f444", "createdAt": "2026-06-05T15:18:27.000Z", "updatedAt": "2026-06-05T15:18:27.000Z", "uid": "35240-2cc2d391-7724-4059-935c-ffdc8c03f444" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.sendgrid.com" } ] }