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
header Parameters
Accept
string
Default: application/hal+json
Finix-Version
string
Default: 2018-01-01

Specify the API version of your request. For more details, see Versioning.

Example: 2022-02-01
Request Body schema: application/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

400

Error

401

Authentication information is missing or invalid

403

Forbidden

406

Not Acceptable

422

Invalid field

post/webhooks
Request samples 
Response samples 
application/json
{}
List Webhooks
Retrieve a list of Webhooks.


For details on how to query endpoints using the available parameters, see Query Parameters.


Request 
query Parameters
limit
integer
The numbers of items to return.


 
 Example:  limit=10
after_cursor
string
Return every resource created after the cursor value.


 
 Example:  after_cursor=TRnasXQ5AmjsLnPMwnme7TL4
before_cursor
string
Return every resource created before the cursor value.


 
 Example:  before_cursor=TRnasXQ5AmjsLnPMwnme7TL4
Responses 
200
List of Webhook objects


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 "Finix-Version: 2022-02-01" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e

Response samples 
application/json
{}
Fetch a Webhook
Retrieve the details of a Webhook.


Request 
path Parameters
webhook_id
required
string
ID of Webhook object.


 
header Parameters
Accept
string
 Default:  application/hal+json
 
Responses 
200
Single Webhook object


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/json" \
  -H "Finix-Version: 2022-02-01" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e

Response samples 
application/json
{}
Update a Webhook
Update an existing Webhookto:



Request 
path Parameters
webhook_id
required
string
ID of Webhook object.


 
header Parameters
Accept
string
 Default:  application/hal+json
 
Finix-Version
string
 Default:  2018-01-01
Specify the API version of your request. For more details, see Versioning.


 
 Example:  2022-02-01
Request Body schema: application/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


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/json
{}