Apideck

Webhook API

Welcome to the Webhook API. You can use this API to access all Webhook API endpoints. Base URL The base URL for all API requests is https://unify.apideck.com…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Welcome to the Webhook API.

You can use this API to access all Webhook API endpoints.

Base URL

The base URL for all API requests is https://unify.apideck.com

Headers

Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.

NameTypeRequiredDescription
x-apideck-consumer-idStringYesThe id of the customer stored inside Apideck Vault. This can be a user id, account id, device id or whatever entity that can have integration within your app.
x-apideck-service-idStringNoDescribe the service you want to call (e.g., pipedrive). Only needed when a customer has activated multiple integrations for the same Unified API.
x-apideck-app-idStringYesThe application id of your Unify application. Available at https://app.apideck.com/unify/api-keys.
AuthorizationStringYesBearer KEY

Authorization

You can interact with the API through the authorization methods below.

-->

Pagination

All API resources have support for bulk retrieval via list APIs. Apideck uses cursor-based pagination via the optional cursor and limit parameters.

To fetch the first page of results, call the list API without a cursor parameter. Afterwards you can fetch subsequent pages by providing a cursor parameter. You will find the next cursor in the response body in meta.cursors.next. If meta.cursors.next is null you're at the end of the list.

In the REST API you can also use the links from the response for added convenience. Simply call the URL in links.next to get the next page of results.

Query Parameters

NameTypeRequiredDescription
cursorStringNoCursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response.
limitNumberNoNumber of results to return. Minimum 1, Maximum 200, Default 20

Response Body

NameTypeDescription
meta.cursors.previousStringCursor to navigate to the previous page of results through the API
meta.cursors.currentStringCursor to navigate to the current page of results through the API
meta.cursors.nextStringCursor to navigate to the next page of results through the API
meta.items_on_pageNumberNumber of items returned in the data property of the response
links.previousStringLink to navigate to the previous page of results through the API
links.currentStringLink to navigate to the current page of results through the API
links.nextStringLink to navigate to the next page of results through the API

⚠️ meta.cursors.previous/links.previous is not available for all connectors.

SDKs and API Clients

We currently offer a Node.js, PHP, Python and .NET SDK.
Need another SDK? Request the SDK of your choice.

Debugging

Because of the nature of the abstraction we do in Apideck Unify we still provide the option to the receive raw requests and responses being handled underlying. By including the raw flag ?raw=true in your requests you can still receive the full request. Please note that this increases the response size and can introduce extra latency.

Errors

The API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below.

CodeTitleDescription …

Endpoints 10

Webhooks

  • GETList webhook subscriptions/webhook/webhooks?cursor=string&limit=20List all webhook subscriptions
  • POSTCreate webhook subscription/webhook/webhooksCreate a webhook subscription to receive events. Delivery URL Validation: The provided delivery_url will be validated synchronously by sending an HTTP POST…
  • GETGet webhook subscription/webhook/webhooks/:idGet the webhook subscription details
  • DELETEDelete webhook subscription/webhook/webhooks/:idDelete a webhook subscription
  • PATCHUpdate webhook subscription/webhook/webhooks/:idUpdate a webhook subscription. Delivery URL Validation: When updating the delivery_url, it will be validated synchronously by sending an HTTP POST request…
  • POSTExecute a webhook/webhook/webhooks/:id/execute/:serviceIdExecute a webhook
  • POSTExecute a webhook/webhook/webhooks/:id/x/:serviceId?l_id=<jwt_token>&e=Employees::Events::EmployeeCreatedExecute a webhook
  • GETResolve and Execute a connection webhook/webhook/w/:id/:serviceId?e=Employees::Events::EmployeeCreatedResolve a webhook based on lookup_id and then execute it
  • POSTResolve and Execute a connection webhook/webhook/w/:id/:serviceId?e=Employees::Events::EmployeeCreated&validationToken=abc123Resolve a webhook based on lookup_id and then execute it
  • GETList event logs/webhook/logs?cursor=string&limit=20&filter={"exclude_apis":"vault,proxy","service":{"id":"string"},"consumer_id":"test_user_id","entity_type":"Connection","event_type":"vault.connection.callable","start_date":"2024-01-01T00:00:00.000Z","end_date":"2024-01-31T23:59:59.999Z","success":true,"status_code":201,"status_codes":[200,201,204],"event_id":"string","execution_attempt":0.0}List event logs

API details

Base URL
https://unify.apideck.com
Authentication
An API key in the Authorization header
Operations
10 operations on 6 pathsGET 4POST 4PATCH 1DELETE 1
Main resources
Webhooks 10
Description format
OpenAPI 3.0.3, API version 10.83.0

How to test the Webhook API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Webhook API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List webhook subscriptions” (GET /webhook/webhooks?cursor=string&limit=20), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Webhook API?

Welcome to the Webhook API. You can use this API to access all Webhook API endpoints. Base URL The base URL for all API requests is https://unify.apideck.com… It is listed under Developer tools and has 10 endpoints.

Who publishes the Webhook API?

It is listed from Apideck's public API description (an OpenAPI document), not published by Apideck on Swastik Codes. Anyone who controls apideck.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Webhook API?

Requests go to https://unify.apideck.com. Endpoint paths are added to this base URL.

How do I authenticate with the Webhook API?

With an API key in the Authorization header.

How many endpoints does the Webhook API have?

10 operations on 6 paths (4 GET, 4 POST, 1 PATCH, 1 DELETE). The largest groups are Webhooks.

Is forking the Webhook API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.