Skip to content
FSCO Docs

Create webhook

POST
/v2/webhook

Create a new webhook.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

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
name
required

The name of the webhook

string
Activate Payment Flow
description
required

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

The events that the webhook will listen to

Array<string>
[
  "document.created",
  "document.scanned",
  "document.updated",
  "ocr.started",
  "ocr.completed",
  "ai.started",
  "ai.processed",
  "ai.event.contentPrompted",
  "ai.promptTested"
]

Responses

Section titled “ Responses ”

201

Section titled “201 ”

The created webhook.

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