Skip to content

Instantly share code, notes, and snippets.

@thinkingserious
Created October 18, 2016 19:30
Show Gist options
  • Save thinkingserious/b7827a2814433b2ee38941ec7ee5f937 to your computer and use it in GitHub Desktop.
Save thinkingserious/b7827a2814433b2ee38941ec7ee5f937 to your computer and use it in GitHub Desktop.
Snippit of the SendGrid OAI (Swagger) Definition - /user/webhooks/parse/settings [GET]
"/user/webhooks/parse/settings": {
"get": {
"consumes": [
"application/json"
],
"description": "**This endpoint allows you to retrieve all of your current inbound parse settings.**\n\nThe inbound parse webhook allows you to have incoming emails parsed, extracting some or all of the contnet, and then have that content POSTed by SendGrid to a URL of your choosing. For more information, please see our [User Guide](https://sendgrid.com/docs/API_Reference/Webhooks/parse.html).",
"operationId": "GET_user-webhooks-parse-settings",
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "",
"examples": {
"application/json": {
"result": [
{
"hostname": "mail.mydomain.com",
"send_raw": true,
"spam_check": true,
"url": "http://mydomain.com/parse"
}
]
}
},
"schema": {
"properties": {
"result": {
"description": "The list of your current inbound parse settings.",
"items": {
"$ref": "#/definitions/parse-setting"
},
"type": "array"
}
},
"type": "object"
}
}
},
"summary": "Retrieve all parse settings",
"tags": [
"Settings - Inbound Parse"
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment