oceanprotocol/webtasks
1
0
Fork 0
mirror of https://github.com/oceanprotocol/webtasks synced 2025-01-06 20:05:40 +01:00
Code Releases Activity

update docs

Browse Source
This commit is contained in:
Matthias Kretschmann 2018-10-21 17:43:33 +02:00
parent 79d59007ad
commit 2719ced69f
Signed by: m
GPG Key ID: 606EEEF3C479A91F
1 changed files with 29 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -67,6 +67,8 @@ http://localhost:8080/
https://TASK_URL/TASK_NAME/
```
**Response**
Response is structured by network and fills it with whatever comes back from respective API:
```json
@ -84,7 +86,7 @@ Response is structured by network and fills it with whatever comes back from res
**`webtask-mailchimp.js`**: Task to add a new newsletter subscriber.
Construct your `/` request url like so, e.g. locally:
Construct your `POST /newsletter` request url like so, e.g. locally:
```bash
http://localhost:8080/newsletter/jelly@mcjellyfish.com
@ -93,6 +95,32 @@ http://localhost:8080/newsletter/jelly@mcjellyfish.com
https://TASK_URL/TASK_NAME/newsletter/jelly@mcjellyfish.com
```
**Response**
When subscription is successful:
```json
{ "status": "created" }
```
When subscriber already exists:
```json
{ "status": "exists" }
```
All errors from MailChimp (when `"status"` is a number) are simply passed through and follow the MailChimp API error responses, e.g.:
```json
{
"type": "http://developer.mailchimp.com/documentation/mailchimp/guides/error-glossary/",
"title": "Forgotten Email Not Subscribed",
"status": 400,
"detail": "matthias@bigchaindb.com was permanently deleted and cannot be re-imported. The contact must re-subscribe to get back on the list.",
"instance": "06171156-4bca-4b6c-a84f-aa3690a82798"
}
```
### Zoho
**`webtask-zoho.js`**: Generic task to subscribe users into lists on Zoho Campaigns & Zoho CRM.