/vaults/verify-webhookVerify Webhook
Outcome - Registers your webhook endpoint for this vault. RoxCustody immediately sends a test POST with an empty JSON body to the URL, signed with your secret; your server must answer with a 2xx status within 10 seconds, otherwise the call fails. Next, choose events with Create Webhook Events. A vault has one webhook.
Body Parameters
urlstringrequiredhttps URLmax(255)Your HTTPS endpoint that will receive events.
secretstringrequiredmax(255)A secret you choose. Used to authenticate deliveries (see authMethod). Printable ASCII only; at least 16 characters with HMAC.
authMethodnumber1 or 2How deliveries are authenticated. 1 = SECRET_HEADER (default, legacy): the secret is sent in the rox-auth-secret header. 2 = HMAC (recommended): each delivery has a Roxcustody-Signature header "t=<unix time>,v1=<signature>", where the signature is HMAC-SHA256(secret, "<t>.<raw body>") in hex; the secret itself is never sent.
Responses
Response attributes
messagestringSuccess message
dataobjectWebhook configuration
Show child attributes (9)
idnumberWebhook ID. Use it in Create/Update Webhook Events.
urlstringYour HTTPS endpoint
vaultIdnumberVault ID
retryCountnumberDefault number of retries for failed deliveries
retryPeriodstringDefault time between retries
authMethodstringSECRET_HEADER or HMAC
eventsobjectEvery event available to this vault type, grouped by category, with subscribed, retryCount and retryPeriod
subscribedEventsCountnumberNumber of events you are subscribed to
eventsDescriptionobjectWhat each event means
statusnumberHTTP status code
Was this page helpful?