/
SH
shipsecai
/
ShipSec Studio API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 1h ago · Updated 4w ago
View markdown
shipsecai
ShipSec Studio API
get
Get a webhook configuration by ID
cc60562ad9f3
latest
OpenAPI 3.0.0
2026-07-17
153
78
310.4 KB
agents
2
analytics
4
api-keys
6
App
4
artifacts
3
audit-logs
1
components
3
files
5
Human Inputs
4
integrations
10
InternalMcp
6
InternalRuns
1
mcp
11
mcp-groups
13
mcp-servers
13
Schedules
8
secrets
7
TestingWebhook
5
webhooks
17
get
/api/v1/webhooks/workflows
get
/api/v1/webhooks/workflows/{id}
post
/api/v1/webhooks/workflows/{id}/run
get
/api/v1/webhooks/runs/{runId}/status
get
/api/v1/webhooks/runs/{runId}/result
post
/api/v1/webhooks/runs/{runId}/cancel
post
Receive inbound webhook
get
List all webhook configurations
post
Create a new webhook configuration
get
Get a webhook configuration by ID
put
Update a webhook configuration
delete
Delete a webhook configuration
post
Regenerate webhook path (creates new URL)
get
Get the webhook URL for a configuration
post
Test a parsing script with sample data
get
List delivery history for a webhook
get
Get details of a specific delivery
workflows
30
webhooks
Get a webhook configuration by ID
get
/api/v1/webhooks/configurations/{id}
Path parameters
id
string
required
Response
WebhookConfigurationResponseDto
required
id
string
uuid
required
workflowId
string
uuid
required
workflowVersionId
string
uuid
nullable
required
workflowVersion
integer
nullable
required
name
string
required
description
string
nullable
required
webhookPath
string
required
parsingScript
string
required
expectedInputs
object[]
required
status
'active'
|
'inactive'
required
organizationId
string
nullable
required
createdBy
string
nullable
required
createdAt
string
date-time
required
updatedAt
string
date-time
required