Outgoing Webhooks

Creates an event for an outgoing webhook.

  • type is required and valid values are: table.recordInsert, table.recordUpdate, table.recordDelete.
  • objectId is required and must be a table identifier.
  • objectFields is optional, applies only to table.recordUpdate, and must be an array of table field names.
  • eventSources is optional and valid values are: Datasheet, DataPages, DataParts, Extensions, RESTAPIs, TriggeredActions, Tasks, DataImports, DataImportTasks.
  • defaultPayloadIncludesSecret is optional and can be set to true or false to include the webhook secret in the event payload.
  • defaultPayloadFields is optional and must be an array of table field names.
  • customPayloadTemplate is optional and must be a string value using single quotes instead of escaped double quotes in JSON.
  • enabled is optional and defaults to true (Active).
post/v4/outgoingWebhooks/{webhookId}/events

Request

  • Base URL: https://demo.caspio.com/integrations/rest
  • URL: https://demo.caspio.com/integrations/rest/v4/outgoingWebhooks/{webhookId}/events
  • Auth: API key in header Authorization

Path parameters

webhookIdstring required

The webhook identifier (6-character alphanumeric code).

Query parameters

echoboolean

When true, returns the created event in the response. Default: false.

Request body

typestring required
objectIdstring required
objectFieldsstring[] nullable
eventSourcesstring[] nullable
defaultPayloadIncludesSecretboolean nullable
defaultPayloadFieldsstring[] nullable
customPayloadTemplatestring nullable
enabledboolean nullable

Response

Created

eventIdstring nullable
typestring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.