Roll secret

POST

/v2/webhook/{webhookId}/roll-secret

• Staging
• Development

Roll the signing secret for a webhook.

Authorizations

• X-API-Key
• X-API-Secret

Parameters

Path Parameters

webhookId

required

string format: uuid

d24d70a9-e1e2-4e83-ac81-cf62c2cb4c09

The ID of the webhook

Responses

201

Created successfully

The new signing secret.

object

id

required

The webhook ID

string format: uuid

d24d70a9-e1e2-4e83-ac81-cf62c2cb4c09

name

The name of the webhook

string

<= 100 characters

Activate Payment Flow

description

The description of the webhook

string

<= 500 characters

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

Allowed values: active disabled paused

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.000Z

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error