{
  "opencollection": "1.0.0",
  "info": {
    "name": "Twilio SendGrid Provisioning Account Event Webhook API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Event Webhook",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Create a new Event Webhook",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sendgrid.com/v3/user/webhooks/event/settings",
            "headers": [
              {
                "name": "on-behalf-of",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "**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 r"
        },
        {
          "info": {
            "name": "Retrieve all of your Event Webhooks.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sendgrid.com/v3/user/webhooks/event/settings/all",
            "headers": [
              {
                "name": "on-behalf-of",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "include",
                "value": "",
                "type": "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."
              }
            ]
          },
          "docs": "**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."
        },
        {
          "info": {
            "name": "Get Signed Event Webhook's Public Key",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sendgrid.com/v3/user/webhooks/event/settings/signed/:id",
            "headers": [
              {
                "name": "on-behalf-of",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the Event Webhook you want to retrieve."
              }
            ]
          },
          "docs": "**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 I"
        },
        {
          "info": {
            "name": "Toggle signature verification for a single Event Webhook by ID",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.sendgrid.com/v3/user/webhooks/event/settings/signed/:id",
            "headers": [
              {
                "name": "on-behalf-of",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the Event Webhook you want to retrieve."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "**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 i"
        },
        {
          "info": {
            "name": "Test an Event Webhook's settings",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sendgrid.com/v3/user/webhooks/event/test",
            "headers": [
              {
                "name": "on-behalf-of",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "**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"
        },
        {
          "info": {
            "name": "Get the settings for a single Event Webhook.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sendgrid.com/v3/user/webhooks/event/settings/:id",
            "headers": [
              {
                "name": "on-behalf-of",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the Event Webhook you want to retrieve."
              },
              {
                "name": "include",
                "value": "",
                "type": "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."
              }
            ]
          },
          "docs": "**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 thei"
        },
        {
          "info": {
            "name": "Update a single Event Webhook by ID.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.sendgrid.com/v3/user/webhooks/event/settings/:id",
            "headers": [
              {
                "name": "on-behalf-of",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the Event Webhook you want to retrieve."
              },
              {
                "name": "include",
                "value": "",
                "type": "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."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "**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 retriev"
        },
        {
          "info": {
            "name": "Delete a single Event Webhook by ID.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.sendgrid.com/v3/user/webhooks/event/settings/:id",
            "headers": [
              {
                "name": "on-behalf-of",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the Event Webhook you want to retrieve."
              }
            ]
          },
          "docs": "**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 unintentio"
        }
      ]
    }
  ],
  "bundled": true
}