SHshipsecai
webhooks

Create a new webhook configuration

Changed on
post/api/v1/webhooks/configurations

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
  • Auth
    none declared

Request body

workflowIdstring uuid required
workflowVersionIdstring uuid
namestring required
descriptionstring
parsingScriptstring required

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