Outgoing Webhooks

Updates the event definition

  • EventType is required and valid values are: table.recordInsert, table.recordUpdate, table.recordDelete.
  • ObjectName is required and must be a table name.
  • ObjectFields is optional, applies only to table.recordUpdate, and must be an array of table field names. If not provided, the webhook is triggered on changes to any table fields.
  • EventSources is optional and valid values are: Datasheet, DataPages, RESTAPIs, TriggeredActions, Tasks, DataImports, DataImportTasks. If not provided or empty, it defaults to all values.
  • DefaultPayloadIncludesSecret is optional and can be set to true or false to include the webhook secret in the event payload. If not provided, it defaults to false.
  • CustomPayloadFields is optional and must be an array of table field names.
  • CustomPayloadTemplate is optional, must be a string value and use single quotes instead of escaped double quotes in JSON.
  • Enabled is optional and can be set to true or false to configure the event Status (Active or Inactive). If not provided, it defaults to true (Active).
put/v3/outgoingWebhooks/{webhookId}/events/{eventId}

Request

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

Path parameters

webhookIdstring required
eventIdstring required

Request body

EventTypestring required
ObjectNamestring nullable
ObjectIdstring nullable
ObjectFieldsstring[] nullable
EventSourcesstring[] nullable
DefaultPayloadIncludesSecretboolean nullable
CustomPayloadFieldsstring[] nullable
CustomPayloadTemplatestring nullable
Enabledboolean nullable

Response

OK

Idstring nullable
Typestring nullable
Statusstring nullable
ObjectNamestring nullable
ObjectIdstring nullable
ObjectFieldsstring[] nullable
EventSourcesstring[] nullable
DefaultPayloadIncludesSecretboolean nullable
CustomPayloadFieldsstring[] nullable
CustomPayloadTemplatestring nullable
LastModifiedstring date-time nullable
ModifiedBystring nullable
DateCreatedstring date-time
CreatedBystring nullable

Changes

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