List webhooks

Example

curl "https://api.switchfile.io/v2/users/me/webhooks" \
  -H "Authorization: Bearer $SWITCHFILE_API_KEY"

const res = await fetch("https://api.switchfile.io/v2/users/me/webhooks", {
  headers: {
    Authorization: `Bearer ${process.env.SWITCHFILE_API_KEY}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());

<?php
$ch = curl_init('https://api.switchfile.io/v2/users/me/webhooks');
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('SWITCHFILE_API_KEY'),
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);

if ($status >= 400) {
    throw new RuntimeException("HTTP $status: $response");
}
print_r(json_decode($response, true));

import os
import requests

res = requests.get(
    "https://api.switchfile.io/v2/users/me/webhooks",
    headers={"Authorization": f"Bearer {os.environ['SWITCHFILE_API_KEY']}"},
)
res.raise_for_status()
print(res.json())

Parameters

Responses

• 200OK

  • dataWebhook[]required
  • data[].created_atstringrequired

    ISO 8601 timestamp, for example 2026-11-06T18:00:00+00:00

  • data[].disabledbooleanrequired

    Always false: switchfile does not disable webhooks on its own

  • data[].eventsstring[]required
  • data[].failingbooleanrequired

    The last delivery to this URL failed

  • data[].idstringrequired

    ID of the webhook (a UUID; CloudConvert uses an integer)

  • data[].last_error_atstring | nullrequired

    ISO 8601 timestamp, for example 2026-11-06T18:00:00+00:00

  • data[].last_response_codestring | nullrequired

    HTTP status of the last failed delivery, or NETWORK_ERROR

  • data[].linksobjectrequired
  • data[].links.selfstringrequired
  • data[].updated_atstringrequired

    ISO 8601 timestamp, for example 2026-11-06T18:00:00+00:00

  • data[].urlstringrequired
  • linksPageLinksrequired
  • links.firststringrequired
  • links.laststring | nullrequired
  • links.nextstring | nullrequired
  • links.prevstring | nullrequired
  • metaPageMetarequired
  • meta.current_pagestring (integer) | integerrequired
  • meta.current_page_urlstringrequired
  • meta.fromstring (integer) | integerrequired
  • meta.pathstringrequired
  • meta.per_pagestring (integer) | integerrequired
  • meta.tostring (integer) | integerrequired

  200 application/jsonCopy

  {
    "data": [
      {
        "id": "1a7e3c5b-9d2f-4b6a-8e0c-5f3d1b7a9c24",
        "url": "https://example.com/hooks/switchfile",
        "disabled": false,
        "events": [
          "job.finished",
          "job.failed"
        ],
        "failing": false,
        "last_error_at": null,
        "last_response_code": null,
        "created_at": "2026-11-06T18:00:00+00:00",
        "updated_at": "2026-11-06T18:00:00+00:00",
        "links": {
          "self": "https://api.switchfile.io/v2/webhooks/1a7e3c5b-9d2f-4b6a-8e0c-5f3d1b7a9c24"
        }
      }
    ],
    "links": {
      "first": "https://api.switchfile.io/v2/users/me/webhooks?page=1",
      "last": null,
      "prev": null,
      "next": null
    },
    "meta": {
      "current_page": 1,
      "current_page_url": "https://api.switchfile.io/v2/users/me/webhooks?page=1",
      "from": 1,
      "path": "https://api.switchfile.io/v2/users/me/webhooks",
      "per_page": 100,
      "to": 1
    }
  }

• 401The API key is missing or not validUNAUTHENTICATED

  401 application/jsonCopy

  {
    "message": "Missing or invalid API key.",
    "code": "UNAUTHENTICATED"
  }

• 404Does not exist for this accountNOT_FOUND

  404 application/jsonCopy

  {
    "message": "Job not found.",
    "code": "NOT_FOUND"
  }

• 422Invalid data. errors names the fieldsINVALID_DATA

  422 application/jsonCopy

  {
    "message": "id: Expected string to match 'uuid' format",
    "code": "INVALID_DATA",
    "errors": {
      "id": [
        "Expected string to match 'uuid' format"
      ]
    }
  }

• 429Too many requests or a daily quota is used up. See Retry-AfterRATE_LIMIT_EXCEEDED

  429 application/jsonCopy

  {
    "message": "Too many requests. Try again in 12 seconds.",
    "code": "RATE_LIMIT_EXCEEDED"
  }

Error bodies and codes are explained in Errors.