Skip to content
vocapable.Docs

Add an HTTPS destination (delivery off until a signed test succeeds)

POST
/v1/workspace/integrations/webhooks/destinations
curl --request POST \
  --url https://api.vocapable.com/v1/workspace/integrations/webhooks/destinations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "url": "example", "events": [ "example" ], "label": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
WorkspaceWebhookDestinationCreate
object
url
required
Url
string
>= 8 characters <= 2048 characters
events
required
Events
Array<string>
>= 1 items <= 20 items
label
Any of:
string
<= 120 characters
Examplegenerated
{
  "url": "example",
  "events": [
    "example"
  ],
  "label": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
WorkspaceWebhookDestinationSecret

Returned exactly once, at creation and at each rotation.

object
destination
required
WorkspaceWebhookDestination
object
id
required
Id
string
installation_id
required
Installation Id
string
kind
required
Kind
string
Allowed values: workspace zapier make
url
required
Url
string
label
required
Any of:
string
events
required
Events
Array<string>
status
required
Status
string
Allowed values: active paused disabled_by_failures
last_verified_at
required
Any of:
string format: date-time
previous_secret_expires_at
required
Any of:
string format: date-time
delivered
required
Delivered
integer
pending
required
Pending
integer
exhausted
required
Exhausted
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
signing_secret
required
Signing Secret
string
Example
{
  "destination": {
    "kind": "workspace",
    "status": "active"
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}