Update webhook

PUT

/v2/webhook/{webhookId}

• Staging
• Development

Update a webhook by its ID.

Authorizations

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

Parameters

Path Parameters

webhookId

required

string format: uuid

The ID of the webhook

Example

77a0049c-7683-45ff-956f-656f257048f7

Header Parameters

X-API-Key

string

API Key

X-API-Secret

string

API Secret

Request Body ^required

object

webhookId

required

The ID of the webhook

string format: uuid

77a0049c-7683-45ff-956f-656f257048f7

name

required

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.

status

The status of the webhook

string

Allowed values: active disabled paused

paused

url

required

The url of the webhook

string format: url

https://api.mycompany.com/webhooks/inbound

enabledEvents

required

The events that the webhook will listen to (use ”*” for all events)

Array<string>

[
  "*",
  "document.created",
  "document.scanned",
  "document.updated"
]

Responses

200

The resource has been successfully updated.

object

id

required

The webhook ID

string format: uuid

77a0049c-7683-45ff-956f-656f257048f7

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