SHshipsecai
webhooks

Update a webhook configuration

Changed on
put/api/v1/webhooks/configurations/{id}

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/api/v1/webhooks/configurations/{id}
  • Auth
    none declared

Path parameters

idstring required

Request body

workflowIdstring uuid
workflowVersionIdstring uuid
namestring
descriptionstring
parsingScriptstring
status'active' | 'inactive'

Response

idstring uuid required
workflowIdstring uuid required
workflowVersionIdstring uuid nullable required
workflowVersioninteger nullable required
namestring required
descriptionstring nullable required
webhookPathstring required
parsingScriptstring required
status'active' | 'inactive' required
organizationIdstring nullable required
createdBystring nullable required
createdAtstring date-time required
updatedAtstring date-time required

Changes