Get webhook by id

GET

webhooks

{webhookId}

TypeScript

const response: Promise<FireblocksResponse<Webhook>> = fireblocks.webhooksV2.getWebhook(webhooksV2ApiGetWebhookRequest);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/webhooks/{webhookId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/webhooks/{webhookId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/webhooks/{webhookId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "url": "https://example.com/webhook",
  "events": [
    "transaction.created",
    "transaction.status.updated"
  ],
  "status": "ENABLED",
  "createdAt": 1625126400000,
  "updatedAt": 1625126400000,
  "description": "This webhook is used for transactions notifications",
  "webhookMtlsId": "6f1b7c62-0f2e-4f1a-9a5e-9f2b1c3d4e5f",
  "webhookOauthId": "123e4567-e89b-12d3-a456-426614174000",
  "customHeaders": [
    "x-gateway-key",
    "x-region-tag"
  ]
}

{
  "message": "<string>",
  "code": 123
}

Path Parameters

webhookId

string<uuid>

required

The unique identifier of the webhook

Example:

"44fcead0-7053-4831-a53a-df7fb90d440f"

Response

A webhook object

string<uuid>

required

The id of the webhook

Example:

"123e4567-e89b-12d3-a456-426614174000"

url

string

required

The url of the webhook where notifications will be sent. Must be a valid URL and https.

Minimum string length: 1

Example:

"https://example.com/webhook"

events

enum<string>[]

required

The events that the webhook will be subscribed to

Available options:

transaction.created,

transaction.status.updated,

transaction.approval_status.updated,

transaction.network_records.processing_completed,

transaction.alert.stuck,

external_wallet.asset.added,

external_wallet.asset.removed,

internal_wallet.asset.added,

internal_wallet.asset.removed,

contract_wallet.asset.added,

contract_wallet.asset.removed,

vault_account.created,

vault_account.asset.added,

vault_account.asset.balance_updated,

vault_account.nft.balance_updated,

vault_account.bulk_create_job_started,

vault_account.bulk_create_job_ended,

vault_account.asset.bulk_add_job_started,

vault_account.asset.bulk_add_job_ended,

embedded_wallet.status.updated,

embedded_wallet.created,

embedded_wallet.asset.balance_updated,

embedded_wallet.asset.added,

embedded_wallet.account.created,

embedded_wallet.device.added,

onchain_data.updated,

connection.added,

connection.removed,

connection.request.waiting_peer_approval,

connection.request.rejected_by_peer,

exchange_account.connected,

fiat_account.connected,

connected_account.connected,

exchange_account.credentials_replaced,

connected_account.credentials_replaced,

ticket.created,

ticket.submitted,

ticket.expired,

ticket.canceled,

ticket.fulfilled,

ticket.counterparty.added,

ticket.counterparty_external_id.set,

ticket.note.added,

ticket.expires_at.set,

ticket.expires_in.set,

ticket.term.added,

ticket.term.updated,

ticket.term.deleted,

ticket.term.funded,

ticket.term.manually_funded,

ticket.term.funding_canceled,

ticket.term.funding_failed,

ticket.term.funding_completed,

ticket.term.transaction_status_changed,

settlement.created,

order.updated,

automation_execution.update

Example:

[
  "transaction.created",
  "transaction.status.updated"
]

status

enum<string>

required

The status of the webhook

Available options:

DISABLED,

ENABLED,

SUSPENDED

Example:

"ENABLED"

createdAt

integer<int64>

required

The date and time the webhook was created in milliseconds

Example:

1625126400000

updatedAt

integer<int64>

required

The date and time the webhook was last updated in milliseconds

Example:

1625126400000

description

string

description of the webhook of what it is used for

Minimum string length: 1

Example:

"This webhook is used for transactions notifications"

webhookMtlsId

string<uuid>

The id of the mTLS configuration this webhook presents when delivering, from /v1/webhooks_settings/mtls. Absent when the webhook does not use mTLS.

Example:

"6f1b7c62-0f2e-4f1a-9a5e-9f2b1c3d4e5f"

webhookOauthId

string<uuid>

The id of the OAuth credentials this webhook authenticates with. Absent when the webhook does not use OAuth. Read the credentials themselves from /v1/webhooks_settings/oauth/{webhookOauthId}.

Example:

"123e4567-e89b-12d3-a456-426614174000"

customHeaders

string[]

Names of the custom headers configured for this webhook. Header values are never returned.

Example:

["x-gateway-key", "x-region-tag"]

⌘I

TypeScript

const response: Promise<FireblocksResponse<Webhook>> = fireblocks.webhooksV2.getWebhook(webhooksV2ApiGetWebhookRequest);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/webhooks/{webhookId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/webhooks/{webhookId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/webhooks/{webhookId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "url": "https://example.com/webhook",
  "events": [
    "transaction.created",
    "transaction.status.updated"
  ],
  "status": "ENABLED",
  "createdAt": 1625126400000,
  "updatedAt": 1625126400000,
  "description": "This webhook is used for transactions notifications",
  "webhookMtlsId": "6f1b7c62-0f2e-4f1a-9a5e-9f2b1c3d4e5f",
  "webhookOauthId": "123e4567-e89b-12d3-a456-426614174000",
  "customHeaders": [
    "x-gateway-key",
    "x-region-tag"
  ]
}

{
  "message": "<string>",
  "code": 123
}

Introduction

Errors & Statuses

API Endpoints

Data Objects

Path Parameters

Response