Skip to content
FSCO Docs

Update webhook

PUT
/v2/webhook/{webhookId}

Update a webhook by its ID.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
webhookId
required
string

The ID of the webhook

Example
f52b1f9e-b9a6-4248-afc5-d3ae358e723a

Header Parameters

Section titled “Header Parameters ”
X-API-Key
string

API Key

X-API-Secret
string

API Secret

Request Body required

Section titled “Request Body required ”
object
webhookId
required

The webhook ID

string
f52b1f9e-b9a6-4248-afc5-d3ae358e723a
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.
status

The status of the webhook

string
Allowed values: active disabled paused 
paused
url
required

The url of the webhook

string
https://api.mycompany.com/webhooks/inbound
enabledEvents
required

The events that the webhook will listen to

Array<string>
[
  "document.created",
  "document.scanned",
  "document.updated"
]

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The resource has been successfully updated.

object
webhookId

The webhook ID

string
f52b1f9e-b9a6-4248-afc5-d3ae358e723a
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
https://api.mycompany.com/webhooks/inbound
enabledEvents
required

A list of event names that this webhook is configured to listen to

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
default: active
Allowed values: active disabled paused 
paused
lastTriggeredAt

The date and time the webhook was last triggered

string
2021-01-01T00:00:00.000Z
createdAt

The creation date

string
2021-01-01T00:00:00.000Z