Webhooks

Webhooks lets you build or set up integrations which subscribe to certain automated notifications (i.e. events) on the Finix API. When one of those events is triggered, a HTTP POST payload is sent to the webhook's configured URL.

Related Guides: Webhooks

Create a Webhook

Create a Webhook to specify an endpoint where Finix can send events.

Request
Request Body schema: application/hal+json
object

The authentication settings that are used to send webhook events.

enabled
boolean

Set to false to disable Webhooks. Default value when created is true.

Array of objects

A list of events the webhook is explicitly enabled for.

url
required
string <= 120 characters

The HTTP or HTTPS URL where callbacks (i.e. events) will be sent via POST request (max 120 characters).

Responses
201

Single Webhook object

Response Schema: application/hal+json
object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

application
string

The ID of the Application resource the Webhook was created under.

object

The authentication settings that are used to send webhook events.

created_at
string <date-time>

Timestamp of when the object was created.

enabled
boolean

Details if the Webhook is enabled:

  • true: Events are being sent to the url.
  • false: Events are not being sent.

Array of objects

A list of events the webhook is explicitly enabled for.

id
string

The ID of the Webhook resource.

updated_at
string <date-time>

Timestamp of when the object was last updated.

url
string

The HTTP or HTTPS URL where callbacks (i.e. events) will be sent via POST request (max 120 characters).

400

Error

401

Authentication information is missing or invalid

403

Forbidden

406

Not Acceptable

422

Invalid field

post/webhooks
Request samples
Response samples
application/hal+json
{}

List Webhooks

Retrieve a list of Webhooks.

Request
query Parameters
after_cursor
string

Return every resource created after the cursor value.

before_cursor
string

Return every resource created before the cursor value.

limit
integer

The numbers of items to return.

Example: limit=10
Responses
200

List of Webhook objects

Response Schema: application/hal+json
object

List of Webhook objects.

object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

object

Details the page that's returned.

401

Authentication information is missing or invalid

403

Forbidden

406

Not Acceptable

get/webhooks
Request samples
curl https://finix.sandbox-payments-api.com/webhooks \
  -H "Content-Type: application/vnd.json+api" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/hal+json
{}

Fetch a Webhook

Retrieve the details of a Webhook.

Request
path Parameters
webhook_id
required
string

ID of Webhook object.

Responses
200

Single Webhook object

Response Schema: application/hal+json
object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

application
string

The ID of the Application resource the Webhook was created under.

object

The authentication settings that are used to send webhook events.

created_at
string <date-time>

Timestamp of when the object was created.

enabled
boolean

Details if the Webhook is enabled:

  • true: Events are being sent to the url.
  • false: Events are not being sent.

Array of objects

A list of events the webhook is explicitly enabled for.

id
string

The ID of the Webhook resource.

updated_at
string <date-time>

Timestamp of when the object was last updated.

url
string

The HTTP or HTTPS URL where callbacks (i.e. events) will be sent via POST request (max 120 characters).

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

get/webhooks/{webhook_id}
Request samples
curl https://finix.sandbox-payments-api.com/webhooks/WHN6HuqRqTV3mDCxoFLrRvP \
  -H "Content-Type: application/vnd.json+api" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples
application/hal+json
{}

Update a Webhook

Update an existing Webhook.

Request
path Parameters
webhook_id
required
string

ID of Webhook object.

Request Body schema: application/hal+json
enabled
boolean

Set to false to disable Webhooks. Default value when created is true.

Array of objects

A list of events the webhook is explicitly enabled for.

url
string

The HTTP or HTTPS url where the callbacks will be sent via POST request (max 120 characters).

Responses
200

Single Webhook object

Response Schema: application/hal+json
object

For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these _links to make your follow-up requests and quickly access relevant IDs.

application
string

The ID of the Application resource the Webhook was created under.

object

The authentication settings that are used to send webhook events.

created_at
string <date-time>

Timestamp of when the object was created.

enabled
boolean

Details if the Webhook is enabled:

  • true: Events are being sent to the url.
  • false: Events are not being sent.

Array of objects

A list of events the webhook is explicitly enabled for.

id
string

The ID of the Webhook resource.

updated_at
string <date-time>

Timestamp of when the object was last updated.

url
string

The HTTP or HTTPS URL where callbacks (i.e. events) will be sent via POST request (max 120 characters).

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

406

Not Acceptable

put/webhooks/{webhook_id}
Request samples
Response samples
application/hal+json
{}