Skip to content

Commit f1bf0c6

Browse files
authored
Merge pull request #291 from signalwire/fix/webhook-timeout-defaults
Fix webhook timeout defaults and parameter names
2 parents 5591d35 + 4f259e2 commit f1bf0c6

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

fern/products/compatibility-api/pages/cxml/guides/webhooks/common-webhook-errors.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Below are some examples of common errors that you might encounter when using web
77

88
## HTML retrieval error (error code 11200)
99

10-
HTML Retrieval Errors happen when there is a failure to retrieve the contents of the URL in your webhook. This indicates that SignalWire tried to reach your URL but did not receive a response before the connection timed out. Our current timeouts are 4.5 seconds for Connect and 5 seconds for Read, and we retry twice once the connection times out.
10+
HTML Retrieval Errors happen when there is a failure to retrieve the contents of the URL in your webhook. This indicates that SignalWire tried to reach your URL but did not receive a response before the connection timed out. Our current timeouts are 2 seconds for Connect and 5 seconds for Read, and we retry twice once the connection times out.
1111

1212
SignalWire automatically retries HTTP retrieval requests. If it's an action type of webhook, SignalWire won't attempt a retry but will go to the fallback URL (on inbound calls, can specify an action URL and a fallback URL). If it's a status callback webhook, SignalWire will retry three times, and back off slightly between each attempt. So the second one will retry very quickly, and for the third retry, the system will wait a few seconds.
1313

fern/products/compatibility-api/pages/cxml/guides/webhooks/index.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -146,18 +146,18 @@ https://your-server.com/endpoint#key=value&key2=value2
146146

147147
| Parameter | Valid values | Default | Notes |
148148
|-----------|--------------|---------|-------|
149-
| Connect Timeout (`ct`) | 100 - 10000 (ms) | 5000 | The timeout in milliseconds SignalWire will wait to establish its TCP connection to your web server. |
150-
| Read Timeout (`rt`) | 100 - 15000 (ms) | 15000 | The amount of time in milliseconds after sending your webhook an HTTP request that SignalWire will wait for the initial HTTP response packet. Also applies to the amount of time SignalWire will wait between individual packets within your HTTP response. |
149+
| Open Timeout (`ot`) | 100 - 10000 (ms) | 2000 | The timeout in milliseconds SignalWire will wait to establish its TCP connection to your web server. |
150+
| Read Timeout (`rt`) | 100 - 15000 (ms) | 5000 | The amount of time in milliseconds after sending your webhook an HTTP request that SignalWire will wait for the initial HTTP response packet. Also applies to the amount of time SignalWire will wait between individual packets within your HTTP response. |
151151
| Total Time (`tt`) | 100 - 15000 (ms) | 15000 | The total time allowed for all timeouts including retries. If not set, the maximum limit is enforced. |
152152

153153
### Examples
154154

155-
#### Set Connect Timeout to 1 second
155+
#### Set Open Timeout to 1 second
156156
```
157-
https://example.com/foo#ct=1000
157+
https://example.com/foo#ot=1000
158158
```
159159

160-
#### Set Connect + Read Timeout to 1 second each
160+
#### Set Open + Read Timeout to 1 second each
161161
```
162-
https://example.com/foo#ct=1000&rt=1000
162+
https://example.com/foo#ot=1000&rt=1000
163163
```

0 commit comments

Comments
 (0)