Skip to content

Commit

Permalink
docs(readme): update README.md for Webhooks
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelSolati committed Jul 23, 2019
1 parent 8b1c193 commit 43948fe
Showing 1 changed file with 30 additions and 17 deletions.
47 changes: 30 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,29 +205,42 @@ Each one of them encapsulates the operations related to it (like listing, updati

### Webhooks

#### `webhooks.create({ uid, tag, url, enable = false, secret, verifySSL })`

- Create a webhook.
- `uid`: Unique ID for the form.
- `tag`: Unique name you want to use for the webhook.
- `url`: Webhook URL.
- `enabled`: `true` if you want to send responses to the webhook immediately. Otherwise, `false`.
- `secret`: If specified, will be used to sign the webhook payload with HMAC SHA256, so that you can verify that it came from Typeform.
- `verifySSL`: `true` if you want Typeform to verify SSL certificates when delivering payloads.

#### `webhooks.delete({ uid, tag })`

- Delete a webhook.
- `uid`: Unique ID for the form.
- `tag`: Unique name of the webhook.

#### `webhooks.get({ uid, tag })`

- Get details for a webhook with the given tag
- `uid`: typeform UID
- `uid`: Unique ID for the form.
- `tag`: tag of the webhook created

#### `webhooks.create({ uid, tag, url, enable = false })`
- Create a webhook with the given tag
- `uid`: typeform UID
- `tag`: (string) tag of the webhook (how are you going to identify it)
- `url`: (string) url of the service you want to notify
- `enable`: (bool)
#### `webhooks.list({ uid })`

#### `webhooks.update({ uid, tag, url, enable = false })`
- Update a webhook with the given tag
- `uid`: typeform UID
- `tag`: (string) tag of the webhook (how are you going to identify it)
- `url`: (string) url of the service you want to notify
- `enable`: (bool)
- Retrieve all webhooks for the specified typeform.
- `uid`: Unique ID for the form.

#### `webhooks.delete({ uid, tag })`
- Delete a webhook with the given tag for a given typeform
- `uid`: typeform UID
- `tag`: (string) tag of the webhook
#### `webhooks.update({ uid, tag, url, enable = false, secret, verifySSL })`

- Update a webhook.
- `uid`: Unique ID for the form.
- `tag`: Unique name you want to use for the webhook.
- `url`: Webhook URL.
- `enabled`: `true` if you want to send responses to the webhook immediately. Otherwise, `false`.
- `secret`: If specified, will be used to sign the webhook payload with HMAC SHA256, so that you can verify that it came from Typeform.
- `verifySSL`: `true` if you want Typeform to verify SSL certificates when delivering payloads.

## Examples

Expand Down

0 comments on commit 43948fe

Please sign in to comment.