Event Webhook Settings

Get Event Webhook Settings [GET]

Request

1
GET https://api.sendgrid.com/v3/user/webhooks/event/settings HTTP/1.1

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
HTTP/1.1 200
{
  "enabled": true,
  "url": "url",
  "group_resubscribe": true,
  "delivered": true,
  "group_unsubscribe": true,
  "spam_report": true,
  "bounce": true,
  "deferred": true,
  "unsubscribe": true,
  "processed": true,
  "open": true,
  "click": true,
  "dropped": true
}

Update Event Notification Settings [PATCH]

Request

1
PATCH https://api.sendgrid.com/v3/user/webhooks/event/settings HTTP/1.1
Request Body
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "enabled": true,
  "url": "url",
  "group_resubscribe": true,
  "delivered": true,
  "group_unsubscribe": true,
  "spam_report": true,
  "bounce": true,
  "deferred": true,
  "unsubscribe": true,
  "processed": true,
  "open": true,
  "click": true,
  "dropped": true
}

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
HTTP/1.1 200
{
  "enabled": true,
  "url": "url",
  "group_resubscribe": true,
  "delivered": true,
  "group_unsubscribe": true,
  "spam_report": true,
  "bounce": true,
  "deferred": true,
  "unsubscribe": true,
  "processed": true,
  "open": true,
  "click": true,
  "dropped": true
}

Test Event Notification Settings [POST]

Sends a fake event notification post to the provided URL.

Request

1
POST https://api.sendgrid.com/v3/user/webhooks/event/test HTTP/1.1
Request Body
1
2
3
{
  "url": "url"
}

Response

1
HTTP/1.1 204