You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: components/woocommerce/README.md
+50Lines changed: 50 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,3 +9,53 @@ WooCommerce is a customizable, open-source eCommerce platform built on WordPress
9
9
-**Automated Order Confirmation Emails**: Use the WooCommerce API to monitor new orders and trigger personalized confirmation emails through a service like SendGrid. This workflow can include order details, expected delivery dates, and upsell opportunities.
10
10
11
11
-**Customer Support Ticket Creation**: On receiving a new customer inquiry or support request via WooCommerce, instantly generate a ticket in a customer support platform like Zendesk. This ensures no customer query goes unnoticed and helps maintain high service standards.
12
+
13
+
# Getting Started
14
+
15
+
To connect your WooCommerce store to Pipedream, create a REST API key.
16
+
17
+
## Creating a WooCommerce REST API Key
18
+
19
+
Open the **WooCommerce** plugin in your WordPress admin dashboard and select the Advanced tab. Navigate to the **REST API** section and click **Create an API key**.
20
+
21
+

22
+
23
+
We recommend naming this API key "Pipedream" to easily remember its purpose. Select a user account that this API key should be tied to, ideally one with at least store manager access.
24
+
25
+
Next, choose the level of permission you’d like Pipedream workflows to have. You can choose between:
26
+
27
+
-**Read** - your Pipedream workflows can only read data, not update or insert new data.
28
+
-**Write** - your Pipedream workflows can update or insert data like orders and products, but cannot read them.
29
+
-**Read/Write** - your Pipedream workflows can both read and write data on your WooCommerce store.
30
+
31
+

32
+
33
+
After generating the API key, you’ll receive a **Consumer Key** and **Consumer Secret**. Copy these values into Pipedream under the respective **Key** and **Secret** fields.
34
+
35
+
Finally, enter your domain name. For example, for `https://example-store.com`, simply enter `example-store.com`. If your store is hosted on a subpath, like `https://my-site.com/store`, enter `my-site.com/store`.
36
+
37
+
Double-check your store’s home URL under the **Settings area in WordPress.**
38
+
39
+
# Troubleshooting
40
+
41
+
## Unable to connect to the WooCommerce REST API
42
+
43
+
### Check your Permalink structure
44
+
45
+

46
+
47
+
To enable Pipedream's access to your WooCommerce store’s REST API, ensure your WordPress site’s Permalink Structure is set to `Post name`. Open the **Settings** area in WordPress, navigate to the **Permalink** section, verify that the **Permalink** setting is set to `Post name`, and click **Save** to apply the change.
48
+
49
+
### Check your WordPress Home URL
50
+
51
+
If you still cannot connect your WooCommerce store to Pipedream, ensure that your site’s Home URL structure is not on a subdomain or subpath. You can find your WordPress site’s Site URL under the Settings > General section.
52
+
53
+
If your site’s URL is `https://example.com`, then the Pipedream `domain` field for your WooCommerce connected account should be `example.com`. If your WordPress site’s home URL is under a different subdomain, such as `https://store.example.com`, then enter `store.example.com` for the `domain` field for your connected account.
54
+
55
+
### Firewall issues
56
+
57
+
By default, Pipedream Workflows originate from dynamic IP addresses within the `us-east-1` region in AWS. To allow Pipedream connections, set up a Pipedream VPC to assign a static IP address to your workflows.
58
+
59
+
## Permissions issues
60
+
61
+
Ensure the user associated with your WooCommerce API key has the necessary permissions to read or write specific resources like products or orders. Additionally, double-check that your API key has read and/or write permissions.
Copy file name to clipboardExpand all lines: docs-v2/pages/components/guidelines.mdx
+9-1Lines changed: 9 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -202,6 +202,8 @@ Here's an example `README.md` structure:
202
202
203
203
# Overview
204
204
205
+
# Example Use Cases
206
+
205
207
# Getting Started
206
208
207
209
# Troubleshooting
@@ -212,7 +214,7 @@ These sections will appear within the correponding app, source and action page,
212
214
213
215
Here's an example of an [app `README.md` within the `discord` component on the Pipedream registry](https://github.com/PipedreamHQ/pipedream/blob/master/components/discord/README.md). That same content is rendered within the [Pipedream integration page for the Discord app](https://pipedream.com/apps/discord).
214
216
215
-
You can add additional subheadings to each of the top level `Overview`, `Getting Started` and `Troubleshooting` headings:
217
+
You can add additional subheadings to each of the top level `Overview`, `Example Use Cases`, `Getting Started` and `Troubleshooting` headings:
216
218
217
219
```markdown
218
220
# Overview
@@ -221,6 +223,12 @@ You can add additional subheadings to each of the top level `Overview`, `Getting
221
223
222
224
Perhaps there are some limitations about the API that users should know about.
0 commit comments