Skip to main content
POST
/
v2
/
workspace
/
advancedwebhook
/
endpoints
/
secret
/
get
Get Advanced Webhook Endpoint Secret
curl --request POST \
  --url https://api.velt.dev/v2/workspace/advancedwebhook/endpoints/secret/get \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '
{
  "data": {
    "endpointId": "<string>"
  }
}
'
{
  "result": {
    "status": "success",
    "message": "Advanced webhook endpoint secret retrieved successfully.",
    "data": {
      "endpointId": "ep_2vK9mPzGqLxYwBnRtCdHsJfAeUo",
      "secret": "whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw"
    }
  }
}
Use this API to retrieve the signing secret for a webhook delivery endpoint. Use the secret to verify the signature of webhook payloads delivered to your endpoint.
This endpoint uses API-key-level auth: pass x-velt-api-key and x-velt-auth-token as headers. You can obtain these from the Get Auth Tokens endpoint.
Advanced webhooks must be enabled for the workspace first via Update Advanced Webhook Config with { "isEnabled": true }. Otherwise this endpoint returns a FAILED_PRECONDITION error.
The signing secret grants the ability to forge webhook payloads that pass signature verification. Store it securely (e.g. in a secrets manager) and never expose it in client-side code.

​
Endpoint

POST https://api.velt.dev/v2/workspace/advancedwebhook/endpoints/secret/get

​
Headers

​
x-velt-api-key
string
required
Your API key.
​
x-velt-auth-token
string
required
Your Auth Token.

​
Body

​
Params

​
data
object
required

​
Example Request

{
  "data": {
    "endpointId": "ep_2vK9mPzGqLxYwBnRtCdHsJfAeUo"
  }
}

​
Example Response

​
Success Response

{
  "result": {
    "status": "success",
    "message": "Advanced webhook endpoint secret retrieved successfully.",
    "data": {
      "endpointId": "ep_2vK9mPzGqLxYwBnRtCdHsJfAeUo",
      "secret": "whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw"
    }
  }
}

​
Failure Response

{
  "error": {
    "status": "NOT_FOUND",
    "message": "Advanced webhook provider request failed."
  }
}

​
Failure Response (advanced webhooks disabled)

{
  "error": {
    "status": "FAILED_PRECONDITION",
    "message": "Advanced webhooks are disabled for this workspace. Enable them via POST /v2/workspace/advancedwebhookconfig/update with { \"isEnabled\": true }."
  }
}

{
  "result": {
    "status": "success",
    "message": "Advanced webhook endpoint secret retrieved successfully.",
    "data": {
      "endpointId": "ep_2vK9mPzGqLxYwBnRtCdHsJfAeUo",
      "secret": "whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw"
    }
  }
}