Skip to content

Commit ff10a50

Browse files
Merge remote-tracking branch 'upstream/a-new-hope-episode-iv' into R2D2
2 parents 1ab8fc4 + 83b749f commit ff10a50

File tree

111 files changed

+364
-346
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

111 files changed

+364
-346
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ seo:
309309
title: Really Great Documentation - SendGrid Documentation | SendGrid
310310
override: true
311311
description: This is some really great documentation! I hope you like it!
312-
canonical: http://sendgrid.com/docs/really-great-docs
312+
canonical: https://sendgrid.com/docs/really-great-docs
313313
---
314314
```
315315

content/docs/for-developers/parsing-email/setting-up-the-inbound-parse-webhook.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -514,17 +514,17 @@ Content analysis details: (0.4 points, 5.0 required)
514514

515515
## Other Inbound Parse Documentation
516516

517-
- [Parse API]({{root_url}}/API_Reference/Web_API_v3/Webhooks/parse.html) -
517+
- [Parse API](https://sendgrid.com/docs/API_Reference/Web_API_v3/Webhooks/parse.html) -
518518
Manage Inbound Parse Webhook settings using the Parse API (Web API v3).
519-
- [Parse Settings Subuser]({{root_url}}/API_Reference/Web_API/Customer_Subuser_API/parse_settings.html) -
519+
- [Parse Settings Subuser](https://sendgrid.com/docs/API_Reference/Web_API/Customer_Subuser_API/parse_settings.html) -
520520
Get current Parse settings and create, edit, and delete entries using the Subuser API (Web API v2).
521-
- [Reseller API Parse Settings]({{root_url}}/API_Reference/Web_API/Reseller_API/parse_settings.html) -
521+
- [Reseller API Parse Settings](https://sendgrid.com/docs/API_Reference/Web_API/Reseller_API/parse_settings.html) -
522522
Get current Parse settings and create, edit, and delete entries using the Reseller API (Web API v2).
523-
- [Reseller Customer Subuser Parse Settings]({{root_url}}/API_Reference/Web_API/Reseller_API/Reseller_Customer_Subuser_API/customer_subuser_parse_settings.html) -
523+
- [Reseller Customer Subuser Parse Settings](https://sendgrid.com/docs/API_Reference/Web_API/Reseller_API/Reseller_Customer_Subuser_API/customer_subuser_parse_settings.html) -
524524
Get current Parse settings and create, edit, and delete entries using the Reseller Customer Subuser API (Web API v2).
525525

526526
## Statistics
527527

528528
SendGrid provides [statistics](https://app.sendgrid.com/statistics/parse_webhook) of how many emails parsed over time. You can specify what is displayed on the graph by adjusting the statistics filters.
529529

530-
For more information, please see [Parse Webhook Stats]({{root_url}}/API_Reference/Web_API_v3/Stats/parse.html).
530+
For more information, please see [Parse Webhook Stats](https://sendgrid.com/docs/API_Reference/Web_API_v3/Stats/parse.html).

content/docs/for-developers/partners/azure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ completion();
229229
230230
``` objc
231231
// Populate the parameters for the SendGrid Web API Call
232-
// Find more details about the [Web API here]({{root_url}}/API_Reference/Web_API/index.html).
232+
// Find more details about the [Web API here]({{root_url}}/api-reference/).
233233
NSString *username = @"<Your SendGrid Username>";
234234
NSString *apikey = @"<Your SendGrid Password>";
235235
NSString *to = @"<Email to Playlist Service from Appendix A>";

content/docs/for-developers/partners/magento.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -14,52 +14,52 @@ navigation:
1414
This extension allows you to configure Magento 2.0 to send all emails using SendGrid. To get started, [click here](https://marketplace.magento.com/sendgrid-email-delivery-simplified.html)!
1515

1616
## Description
17-
17+
1818
The official SendGrid extension for Magento 2.0 makes it easy to ensure delivery of your most important transactional emails. Purchase receipts, shipping confirmations, and password reset emails are at the core of how you engage with your customers, helping to fuel your store’s growth. Email delivery is our passion. Entrust our industry-leading email delivery platform, including world-class deliverability tools and expertise to make sure your transactional emails get to the inbox.
1919

2020
Transactional email is an important component of any email communication strategy. SendGrid relieves businesses of the cost and complexity of maintaining custom email systems. SendGrid provides reliable delivery, scalability and real-time analytics along with flexible APIs that make custom integration a breeze. SendGrid for Magento 2.0 allows you to choose between the SMTP relay or the Email API to send outgoing emails from your Magento installation.
2121

2222
## SendGrid Pricing Plans
23-
23+
2424
Plans start at $9.95/month. Please see our [pricing page](https://sendgrid.com/partners/magento/) for more information.
2525

2626
For a free trial, [click here](https://sendgrid.com/partners/magento/)!
2727

2828
## Main Features
29-
29+
3030
### Proven Deliverability
31-
31+
3232
Trusted email deliverability features including email authentication, reputation monitoring, dedicated IP addresses, and more.
3333

3434
### Scale with Confidence
35-
35+
3636
Our world-class email platform delivers over 30 billion emails per month for our customers.
3737

3838
### Support
39-
39+
4040
[24/7 support](https://support.sendgrid.com) available to answer your email needs. We also provide a full library of self-support materials here.
4141

4242
### Reporting
43-
43+
4444
Learn more about your shoppers’ engagement with performance feedback and real-time analytics on requests, deliveries, opens, bounces, unsubscribes, clicks, and more.
4545

4646
## What’s the functionality of your extension?
47-
47+
4848
* Our extension easily integrates with your SendGrid API key and allows you to send your Magento email with confidence through our world class infrastructure.
4949
* In addition to reliable delivery and scalability, our extension allows you have access to real-time analytics and insights for quick, well-informed decision making about your customers to grow your e-commerce store.
5050
* Integrate easily with your SendGrid API key
5151

5252
## What makes your extension unique?
53-
53+
5454
* SendGrid pioneered the cloud-based email industry, and we are trusted by leading senders like Uber, AirBnB, and Spotify to achieve optimal deliverability at scale.
5555
* Flexible API and SMTP setup for for easy transactional email Integration.
5656
* Key email deliverability features including email authentication, reputation monitoring, dedicated IP addresses, and more.
5757
* Real-time analytics and reporting including opens, clicks, bounces, unsubscribe tracking, and more.
58-
* Leverage our step-by-step [documentation](https://sendgrid.com/docs) or get quick help from our [24/7 Support Team](https://support.sendgrid.com).
58+
* Leverage our step-by-step [documentation](https://sendgrid.com/docs/api-reference/) or get quick help from our [24/7 Support Team](https://support.sendgrid.com).
5959
* This official extension was built for M2 by SendGrid’s dedicated partner-focused teams for continued management and future development.
6060

6161
## Configuration
62-
62+
6363
First, log in to your **Magento Dashboard**, then click **System** in the left hand navigation bar. Select **SendGrid** and click **Settings**. Here, you can enter your SendGrid account settings.
6464

6565
1. To get the SendGrid plugin running after activation, navigate to the plugin's settings page and enter your **SendGrid API Key**. Next, choose how your email will be sent (SMTP Relay or Email API).
@@ -72,15 +72,17 @@ First, log in to your **Magento Dashboard**, then click **System** in the left
7272

7373
![]({{root_url}}/images/magento_3.jpg)
7474

75-
3. Emails are automatically tracked and tagged to provide you deliverability and engagement statistics viewable from the **SendGrid Dashboard**. You can also add other [categories]({{root_url}}help-support/analytics-and-reporting/categories/) for your emails in the field Categories.
75+
76+
3. Emails are automatically tracked and tagged to provide you deliverability and engagement statistics viewable from the **SendGrid Dashboard**. You can also add other [categories]({{root_url}}/help-support/analytics-and-reporting/categories/) for your emails in the field Categories.
7677

7778
![]({{root_url}}/images/magento_4.png)
7879

7980
4. Set the **template ID** to be used in all your emails on the settings page.
8081

8182
![]({{root_url}}/images/magento_5.png)
8283

83-
5. Next, select the [unsubscribe group]({{root_url}}/help-support/sending-email/index-suppressions/).
84+
85+
5. Next, select the [unsubscribe group]({{root_url}}/help-support/sending-email/unsubscribe-groups/).
8486

8587
![]({{root_url}}/images/magento_6.png)
8688

@@ -89,23 +91,23 @@ First, log in to your **Magento Dashboard**, then click **System** in the left
8991
![]({{root_url}}/images/magento_7.png)
9092

9193
### Statistics
92-
94+
9395
Log into your **Magento Dashboard**, then click **System** in the left hand navigation bar. Select **SendGrid** and click **Statistics** to see your statistics.
9496

9597
![]({{root_url}}/images/magento_8.jpg)
9698

9799
### Requirements
98-
100+
99101
* Magento Community Edition 2.x or Magento Enterprise Edition 2.x
100102

101103
## Frequently Asked Questions
102-
104+
103105
### What credentials do I need to add on settings page?
104-
106+
105107
[Create a SendGrid account](https://sendgrid.com/partners/magento/) and [generate a new API key](https://app.sendgrid.com/settings/api_keys). For more information about API Keys, [click here]({{root_url}}/help-support/account-and-settings/api-keys/).
106108

107109
### What permissions should my API keys have?
108-
110+
109111
Your API Key must have the following permissions:
110112

111113
<table class="table">

content/docs/for-developers/partners/microsoft-azure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ If you are using Microsoft’s cloud platform you can easily integrate with Send
1515
2. [Node.js](http://azure.microsoft.com/en-us/documentation/articles/store-sendgrid-nodejs-how-to-send-email/)
1616
3. [.NET](http://azure.microsoft.com/en-us/documentation/articles/sendgrid-dotnet-how-to-send-email/)
1717
4. [Java](http://azure.microsoft.com/en-us/documentation/articles/store-sendgrid-java-how-to-send-email/)
18-
5. [Java]({{root_url}}/Integrate/Tutorials/WindowsAzure.html) via an Azure webpage
18+
5. [Java]({{root_url}}/for-developers/partners/azure/) via an Azure webpage
1919
6. [Mobile Services](http://azure.microsoft.com/en-us/documentation/articles/store-sendgrid-mobile-services-send-email-scripts/)
2020

2121
## Still have questions?

content/docs/for-developers/sending-email/api-getting-started.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ navigation:
1414
There are several ways you can get started with the SendGrid API
1515

1616
## Prerequisites
17-
17+
1818
These instructions describe how to send your first email using cURL calls. This is one of many ways to send email with the SendGrid - we also have [PHP](https://github.com/sendgrid/sendgrid-php), [Python](https://github.com/sendgrid/sendgrid-python), [Node.js](https://github.com/sendgrid/sendgrid-nodejs), [Java](https://github.com/sendgrid/sendgrid-java), [C#](https://github.com/sendgrid/sendgrid-csharp), [Go](https://github.com/sendgrid/sendgrid-go), and [Ruby](https://github.com/sendgrid/sendgrid-ruby) libraries.
1919

2020
Before you can start using the API, you need to do the following:
2121

2222
1. Create a SendGrid [account](https://sendgrid.com/pricing/).
23-
2. Create an [API Key]({{root_url}}/help-support/account-and-settings/api-keys.html).
23+
2. Create an [API Key]({{root_url}}/help-support/account-and-settings/api-keys/).
2424
3. Make sure you have [curl](https://curl.haxx.se/) installed on your machine.
2525

2626
<call-out>
@@ -30,18 +30,18 @@ Curl comes standard on Mac operating systems.
3030
</call-out>
3131

3232
## How to send an API email
33-
33+
3434
### Build your API call
35-
35+
3636
Your API call must have the following components:
3737

3838
* A Host. The host for Web API v3 requests is always https://sendgrid.com/v3/
3939
* An [Authorization Header](https://sendgrid.api-docs.io/v3.0/how-to-use-the-sendgrid-v3-api/api-authentication#authorization-header)
40-
* An [API Key]({{root_url}}/help-support/account-and-settings/api-keys.html) within the Authorization Header
40+
* An [API Key]({{root_url}}/help-support/account-and-settings/api-keys/) within the Authorization Header
4141
* A Request. When submitting data to a resource via POST or PUT, you must submit your payload in JSON.
4242

4343
### Send your email using the API
44-
44+
4545
_To Send an email using the SendGrid API:_
4646

4747
```
@@ -66,13 +66,13 @@ If you have not yet set up [Sender Authentication]({{root_url}}/help-support/sen
6666
</call-out>
6767
6868
### API Response messages
69-
69+
7070
All responses are returned in JSON format. We specify this by sending the ``Content-Type`` header. The Web API v3 provides a selection of [response codes](https://sendgrid.api-docs.io/v3.0/how-to-use-the-sendgrid-v3-api/api-responses#status-codes),[content-type headers](https://sendgrid.api-docs.io/v3.0/how-to-use-the-sendgrid-v3-api/api-responses#content-type-header), and [pagination](https://sendgrid.api-docs.io/v3.0/how-to-use-the-sendgrid-v3-api/api-responses#pagination) options to help you interpret the responses to your API requests.
7171
7272
## Next Steps
73-
73+
7474
For more information on SendGrid and where you can go from here, check out these pages:
7575
76-
- [API Reference]({{root_url}}/API_Reference/api_v3.html)
76+
- [API Reference]({{root_url}}/api-reference/)
7777
- [Sender Authentication]({{root_url}}/help-support/sending-email/how-to-set-up-domain-authentication.html)
7878
- [How to Send Email]({{root_url}}/help-support/sending-email/how-to-send-email.html)

content/docs/for-developers/sending-email/building-an-smtp-email.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ For more information, see our [unique arguments documentation]({{root_url}}/for-
185185

186186

187187
- [How to send email]({{root_url}}/help-support/sending-email/how-to-send-email/)
188-
- [Getting started with the API]({{root_url}}/API_Reference/api_v3.html)
188+
- [Getting started with the API]({{root_url}}/api-reference/)
189189
- [SMTP Service Crash Course](https://sendgrid.com/blog/smtp-service-crash-course/)
190190
- [Getting Started with the SMTP API]({{root_url}}/for-developers/sending-email/sending-email-smtp/)
191191
- [Integrating with SMTP]({{root_url}}/for-developers/sending-email/integrating-with-the-smtp-api/)

content/docs/for-developers/sending-email/categories.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ navigation:
77
show: true
88
---
99

10-
You can add [categories]({{root_url}}/help-support/analytics-and-reporting/categories/) to the X-SMTPAPI header of the emails you send via SendGrid. This will allow you to track emails based on your own categorization system.
10+
You can add [categories]({{root_url}}/glossary/categories/) to the X-SMTPAPI header of the emails you send via SendGrid. This will allow you to track emails based on your own categorization system.
1111

1212
<call-out type="warning">
1313

@@ -29,7 +29,7 @@ Categories should be used to group messages together by broad topic. If you need
2929

3030
## Example
3131

32-
You can use SendGrid's [SMTP API]({{root_url}}/API_Reference/SMTP_API/) to add these categories to your email. The following should be added to the email's header:
32+
You can use SendGrid's [SMTP API]({{root_url}/for-developers/sending-email/getting-started-smtp/) to add these categories to your email. The following should be added to the email's header:
3333

3434
### Example Category Header
3535
```json

content/docs/for-developers/sending-email/curl-examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ curl --request POST \
6565

6666
## Scheduling and Cancelling an Email
6767

68-
You may schedule an email to be sent up to 72 hours in the future by using the "send_at" parameter. You may cancel this same scheduled email by using the [Cancel Scheduled Sends endpoint]({{root_url}}/API_Reference/Web_API_v3/cancel_schedule_send.html).
68+
You may schedule an email to be sent up to 72 hours in the future by using the "send_at" parameter. You may cancel this same scheduled email by using the [Cancel Scheduled Sends endpoint](https://sendgrid.com/docs/API_Reference/Web_API_v3/cancel_schedule_send.html).
6969

7070
**Step 1: Generate a batch ID**
7171
```bash

content/docs/for-developers/sending-email/getting-started-email-activity-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -270,4 +270,4 @@ This is a full list of basic query types and examples: (replace the data in quot
270270
## Additional Resources
271271

272272
- [Email Activity Feed API Reference](https://sendgrid.api-docs.io/v3.0/email-activity/filter-all-messages)
273-
- [Email Activity Feed UI](https://sendgrid.com/docs/help-support/analytics-and-reporting/email-activity-feed.html)
273+
- [Email Activity Feed UI]({{root_url}}/help-support/analytics-and-reporting/email-activity-feed/)

0 commit comments

Comments
 (0)