SEsendspark
Webhook

Modify Webhook

Changed on

Modify Webhook

patch/v1/workspaces/{workspaceId}/webhooks/{webhookId}

Request

  • Base URL
    https://api-gw.sendspark.com
  • Auth
    API key in header x-api-key and API key in header x-api-secret

Path parameters

workspaceIdstring required
webhookIdstring required

Request body

namestring
descriptionstring
extraHeadersstring[]
urlstring
module'global' | 'dynamics'
identifiersstring[]
eventsModel217[]
enabledboolean

Example request

{
  "name": "Production Webhook",
  "description": "Webhook for production environment",
  "extraHeaders": [
    "Authorization",
    "Content-Type"
  ],
  "url": "https://example.com/webhook",
  "module": "global | dynamics",
  "identifiers": [
    "sdfgh2345werty345678dfghj"
  ],
  "events": [
    "video_watched",
    "video_played",
    "video_cta_clicked",
    "video_viewed",
    "video_liked",
    "video_request_received",
    "video_generated_dv",
    "video_mp4_ready",
    "video_generated_error"
  ],
  "enabled": true
}

Response

Successful

ModifyWebhookResponseSchema required

Changes