Saltar al contenido principal
GET
/
webhooks
@firma-dev/sdk
import { FirmaClient } from "@firma-dev/sdk";

const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });

const response = await firma.webhooks.listWebhooks();
console.log(response);
curl --request GET \
--url https://api.firma.dev/functions/v1/signing-request-api/webhooks \
--header 'Authorization: <api-key>'
import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/webhooks"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.firma.dev/functions/v1/signing-request-api/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.firma.dev/functions/v1/signing-request-api/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);

$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.firma.dev/functions/v1/signing-request-api/webhooks"

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

req.Header.Add("Authorization", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.firma.dev/functions/v1/signing-request-api/webhooks")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/webhooks")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "events": [
        "<string>"
      ],
      "enabled": true,
      "created_at": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "consecutive_failures": 123,
      "auto_disabled_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "current_page": 123,
    "page_size": 123,
    "total_count": 123,
    "total_pages": 123
  }
}

Autorizaciones

Authorization
string
header
requerido

Clave API para autenticación. Usa tu clave API directamente sin ningún prefijo (por ejemplo, 'your-api-key'). El prefijo Bearer es opcional pero no obligatorio.

Parámetros de consulta

page
integer
predeterminado:1

Número de página

Rango requerido: x >= 1
page_size
integer
predeterminado:50

Elementos por página

Rango requerido: 1 <= x <= 200
enabled
enum<string>

Filtrar por estado habilitado (0=deshabilitado, 1=habilitado)

Opciones disponibles:
0,
1
url
string

Filtrar por URL del webhook (coincidencia parcial, sin distinguir mayúsculas/minúsculas)

event
string

Filtrar por tipo de evento (por ejemplo, 'signing_request.completed')

created_after
string<date-time>

Filtrar webhooks creados después de esta fecha (formato ISO 8601)

created_before
string<date-time>

Filtrar webhooks creados antes de esta fecha (formato ISO 8601)

sort_by
enum<string>
predeterminado:created_on

Campo por el cual ordenar

Opciones disponibles:
url,
enabled,
created_on,
last_changed_on,
consecutive_failures
sort_order
enum<string>
predeterminado:desc

Orden de clasificación

Opciones disponibles:
asc,
desc
workspace_id
string<uuid>

Filtrar webhooks por espacio de trabajo. Cuando se proporciona, devuelve solo los webhooks asociados a ese espacio de trabajo. Cuando se omite, devuelve solo los webhooks a nivel de empresa.

Respuesta

Webhooks recuperados correctamente

Lista paginada de webhooks

results
object[]
requerido
pagination
object
requerido

Metadatos de paginación para respuestas de listas