Don't forget to check out our JSON RESTful APIs, they can help you utilize and extend Quickbase with ease.
Overview
Use API_Webhooks_Create to set up and configure a webhook.
Request Parameters
| Parameter | Value | Required? |
|---|---|---|
|
Label |
A unique name for the webhook |
yes |
|
Description |
Description of the webhoook |
no |
|
Query |
Filter criteria to trigger the webhook |
no |
|
WorkflowWhen |
Condition to trigger the webhook: a = add (default) d = delete m = modify These can be combined in any order, for example "mda" (modify, delete, add) |
no |
| WebhookURL |
Endpoint URL for the webhook. This must begin with: https:// Example: https://myApp.quickbase.com/db/xxxxxx |
yes |
| WebhookHeader |
Key value pair of the header. A name/value pair that typically describes the format of the message, for example: Content-Type: application/json. If the webhook is going to another Quickbase table, you can provide the API call name (either here or in the URL); for example: Quickbase-Action: API_AddRecord. |
No |
| WebhookHeaderCount |
The number of webhook headers. For example: WebhookHeaderCount=1 |
No |
| WebhookHeaderKey(n) |
For example: WebhookHeaderKey1=TOKEN |
No |
| WebhookHeaderValue(n) |
Example: WebhookHeaderValue1=VALUE |
No |
| WebhookMessage | Payload of the webhook (empty by default). | no |
| WebhookMessageFormat |
Format of the payload: XML (default) JSON RAW |
no |
|
WebhookHTTPVerb |
A string value that you want returned. It will not be handled by Quickbase but it will be returned in the response. Specifies the HTTP method for the webhook: POST (default) GET PUT PATCH DELETE |
no |
| tfidsWhich |
Set the field IDs criteria to determine if webhook should be triggered. The webhook will fire only if at least one of the indicated fields has changed. Set the value of this parameter to TRUE and for every field ID that should be added to criteria add 'tfids' request parameter. Set the value of this parameter to 'tfidsAny' to clear criteria and fire webhook on any changed field. Example: <tfidsWhich>TRUE</tfidsWhich><tfids>6</tfids><tfids>9</tfids> |
No |
Response values
| Property tag | Description |
|---|---|
|
action |
Webhooks API name (for example, API_Webhooks_Create) |
| errcode | numeric error code |
|
errtext |
error text, for example: "invalid input" |
Sample XML Request
POST https://target_domain/db/target_dbid?
Content-Type: application/xml
Content-Length:
QUICKBASE-ACTION: API_Webhooks_Create
<qdbapi>
<usertoken>buacrj_uyp_iag2s56b7t8opp5edsvt</usertoken>
<label>Label</label>
<WebhookURL>https://target_domain/db/target_dbid?</WebhookURL>
</qdbapi>
URL alternative
https://realm.quickbase.com/db/tableId?a=API_Webhooks_Create&Label=New&WebhookURL=https://https://realm.quickbase.com/db/tableId
Sample response
Success
<qdbapi>
<action>API_Webhooks_Create</action>
<errcode>0</errcode>
<errtext>No error</errtext>
<changed>true</changed>
<success>true</success>
</qdbapi>
Failure
<qdbapi>
<action>API_Webhooks_Create</action>
<errcode>2</errcode>
<errtext>Invalid input</errtext>
<errdetail></errdetail>
</qdbapi>