API_Webhooks_Edit

Overview

Use API_Webhooks_Edit to edit webhooks.

Request Parameters

Parameter Value Required?

actionID

The ID of the webhook action

yes

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 Quick Base table, you can provide the API call name (either here or in the URL); for example: Quick Base-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 Quick Base 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

top

Response values

Property tag Description

action

Webhooks API name (for example, API_Webhooks_Edit)

errcode numeric error code

errtext

error text, for example: "invalid input"

top

Sample XML Request

POST https://target_domain/db/target_dbid?
Content-Type: application/xml Content-Length:
QUICKBASE-ACTION: API_Webhooks_Edit
<qdbapi>
<usertoken>buacrj_uyp_iag2s56b7t8opp5edsvt</usertoken>
<actionId>15</actionId>
<label>EditedWebhook</label>
<WebhookURL>https://myApp.quickbase.com/bin/49b9b88b-5ac9-43ba-93a0-096f99816afb</WebhookURL>
<WebhookMessage>Webhook edited version 2</WebhookMessage>
<WebhookMessageFormat>JSON</WebhookMessageFormat>
</qdbapi>

top

URL alternative

https://myApp.quickbase.com/db/bmdihpya6?a=API_Webhooks_Edit&actionId=11

Sample response

<?xml version="1.0" ?>
<qdbapi>
<action>API_Webhooks_Edit</action>
<errcode>0</errcode>
<errtext>No error</errtext>
<changed>true</changed>
<success>true</success>
</qdbapi>

 

Go back    |     |  

© 1999-2018 QuickBase, Inc. All rights reserved. Legal Notices.