Parse Webhook Settings

get

Retrieve settings already configured for parsing incoming email.

Parameters

Parameter Required Requirements Description
api_user Yes alphanumeric SendGrid Username
api_key Yes alphanumeric SendGrid password

Call

1

https://sendgrid.com/api/parse.get.json?api_user=youremail@domain.com&api_key=secureSecret

Response: Success

1
2
3
4
5
6
7
8
9

{
  "parse": [
    {
      "hostname": "www.example.com",
      "url": "www.mydomain.com/parse.php",
      "spam_check": 1
    }
  ]
}

Response: Empty

1
2
3
4
5

{
  "parse": [

  ]
}

Call

1

https://sendgrid.com/api/parse.get.xml?api_user=youremail@domain.com&api_key=secureSecret

Response: Success

1
2
3
4
5
6
7
8
9

<?xml version="1.0" encoding="ISO-8859-1"?>

<parse>
   <entry>
      <hostname>www.example.com</hostname>
      <url>www.mydomain.com/parse.php</url>
      <spam_check>1</spam_check>
   </entry>
</parse>

Response: Empty

1

<parse></parse>

set

Specify the hostname and url for parsing incoming emails.

Parameters

Parameter Required Requirements Description
api_user Yes alphanumeric SendGrid Username
api_key Yes alphanumeric SendGrid password
hostname Yes alphanumeric The hostname (domain or subdomain) for which you would like to configure a Parse Webhook callback URL.
url Yes alphanumeric The callback URL to which Parse Webhook payloads will be POSTed.
spam_check No 0 or 1 If spam check is enabled, messages that look like spam will not be POSTed.

Call

1

https://sendgrid.com/api/parse.set.json?api_user=youremail@domain.com&api_key=secureSecret&hostname=www.example.com&url=www.mydomain.com/parse.php&spam_check=1

Response: Success 

1
2
3

{
  "message": "success"
}

Response: Error

1
2
3
4
5
6

{
  "message": "error",
  "errors": [
    "...error messages..."
  ]
}

Call

1

https://sendgrid.com/api/parse.set.xml?api_user=youremail@domain.com&api_key=secureSecret&hostname=www.example.com&url=www.mydomain.com/parse.php&spam_check=1

Response: Success

1
2
3
4
5

<?xml version="1.0" encoding="ISO-8859-1"?>

<result>
   <message>success</message>
</result>

Response: Error

1
2
3
4
5
6
7
8
9
10
11

<?xml version="1.0" encoding="ISO-8859-1"?>

<result>
   <message>error</message>
   <errors>
      ...
      <error>... error messages ...</error>
      ...
   </errors>
   @nodes
</result>

Edit Entry

Edit your existing settings for parsing incoming emails.

Parameters

Parameter Required Requirements Description
api_user Yes alphanumeric SendGrid Username
api_key Yes alphanumeric SendGrid password
hostname Yes alphanumeric The hostname (domain or subdomain) for which you would like to configure a Parse Webhook callback URL.
url Yes alphanumeric The callback URL to which Parse Webhook payloads will be POSTed.
spam_check No 0 or 1 If spam check is enabled, messages that look like spam will not be POSTed.

Call

1

https://sendgrid.com/api/parse.set.json?api_user=youremail@domain.com&api_key=secureSecret&hostname=www.example.com&url=www.mydomain.com/parse.php&spam_check=1

Response: Success

1
2
3

{
  "message": "success"
}

Response: Error

1
2
3
4
5
6

{
  "message": "error",
  "errors": [
    "...error messages..."
  ]
}

Call

1

https://sendgrid.com/api/parse.set.xml?api_user=youremail@domain.com&api_key=secureSecret&hostname=www.example.com&url=www.mydomain.com/parse.php&spam_check=1

Response: Success

1
2
3

<result>
  <message>success</message>
</result>

Response: Error

1
2
3
4
5
6
7
8
9
10
11

<?xml version="1.0" encoding="ISO-8859-1"?>

<result>
   <message>error</message>
   <errors>
      ...
      <error>... error messages ...</error>
      ...
   </errors>
   @nodes
</result>

Delete Entry

Delete the existing settings for parsing incoming emails.

Parameters

Parameter Required Requirements Description
api_user Yes alphanumeric SendGrid Username
api_key Yes alphanumeric SendGrid password
hostname Yes alphanumeric The hostname (domain or subdomain) for which you would like to delete Parse Webhook settings.

Call

1

https://sendgrid.com/api/parse.delete.json?api_user=youremail@domain.com&api_key=secureSecret&hostname=www.example.com

Response: Success

1
2
3

{
  "message": "success"
}

Response: Error

1
2
3
4
5
6

{
  "message": "error",
  "errors": [
    "...error messages..."
  ]
}

Call

1

https://sendgrid.com/api/parse.delete.xml?api_user=youremail@domain.com&api_key=secureSecret&hostname=www.example.com

Response: Success

1
2
3
4
5

<?xml version="1.0" encoding="ISO-8859-1"?>

<result>
   <message>success</message>
</result>

Response: Error

1
2
3
4
5
6
7
8
9
10
11

<?xml version="1.0" encoding="ISO-8859-1"?>

<result>
   <message>error</message>
   <errors>
      ...
      <error>... error messages ...</error>
      ...
   </errors>
   @nodes
</result>