Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Webhooks

Update Webhook

Update an existing Webhook to:

  • Enable or disable a Webhook. Disabled webhooks stop receiving events at the configured URL.
  • Add authentication to a Webhook
  • Override default event filters by specifying the list of events you are interested in receiving
put/webhooks/{webhook_id}

Request body

OR
OR
OR

Example request

{
  "enabled_events": [
    {
      "entity": "transfer",
      "types": [
        "created"
      ]
    }
  ],
  "url": "https://httpbin.org/post"
}

Response

A single Webhook

idstring

The ID of the resource.

created_atstring date-time

Timestamp of when the object was created.

updated_atstring date-time

Timestamp of when the object was last updated.

applicationstring

ID of the Application the resource was created under.

enabledboolean

Whether the Webhook is enabled. Disabled webhooks will not receive events.

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

Whether the Webhook is currently accepting events; this field mirrors the enabled field.

nicknamestring

A human-readable name for the Webhook.

previous_secret_expires_atstring nullable

The time when the previous secret_signing_key expires. Set when the signing key is rotated; null on initial creation.

secret_signing_keystring nullable

Use this key to verify the Finix-Signature header on incoming webhook events, confirming the payload came from Finix, was not tampered with, and was sent recently. For details, see Verifying Webhook Signatures.

urlstring

The HTTP or HTTPS URL to receive events. When an event occurs, Finix sends a POST request to this URL with the webhook event payload.

Example response

{
  "enabled_events": [
    {
      "entity": "transfer",
      "types": [
        "created"
      ]
    }
  ]
}