Skip to content
FSCO Docs

Get webhooks

GET
/v2/webhook

List all webhooks with pagination.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
page[number]
number

Page number (starts at 1)

Example
1
page[size]
number

Items per page

Example
10

Header Parameters

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

API Key

X-API-Secret
string

API Secret

Responses

Section titled “ Responses ”

200

Section titled “200 ”

List of webhooks.

object
items
required

List of webhooks

Array<object>
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
page
required

Object with the page number and the number of items per page

object
number
required

The current page number.

number
1
size
required

The number of items per page.

number
10
totalPages
required

The total number of pages available.

number
100
totalCount
required

The total number of items available.

number
1000
hasNext
required

Indicates whether there is a next page available.

boolean
true
hasPrev
required

Indicates whether there is a previous page available.

boolean
true