Roll secret
POST /v2/webhook/{webhookId}/roll-secret
POST
/v2/webhook/{webhookId}/roll-secret
Roll the signing secret for a webhook.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” webhookId
required
string format: uuid
The ID of the webhook
Example
77a0049c-7683-45ff-956f-656f257048f7Header Parameters
Section titled “Header Parameters ” X-API-Key
string
API Key
X-API-Secret
string
API Secret
Responses
Section titled “ Responses ”The new signing secret.
object
id
required
The webhook ID
string format: uuid
77a0049c-7683-45ff-956f-656f257048f7 name
The name of the webhook
string
Activate Payment Flow description
The description of the webhook
string
This webhook weill receive the notifications to trigger payments in our platform. url
required
The url of the webhook
string format: url
https://api.mycompany.com/webhooks/inbound enabledEvents
required
A list of event names that this webhook is configured to listen to (use ”*” for all events)
Array<string>
[ "*", "document.created", "document.scanned", "document.updated"] signingSecret
The secret used to sign the webhook payload
string
1234567890 status
The status of the webhook
string
active createdAt
The creation date
string format: date-time
2021-01-01T00:00:00.000Z lastTriggeredAt
The last triggered date
string format: date-time
2021-01-01T00:00:00.000ZBad Request
Unauthorized
Forbidden
Not Found
Internal Server Error