capabilities.work

Connection And Webhook Provisioning

A 4-step recipe with Unified.to. We can help you get access.

Recipe · 4 steps

Connection And Webhook Provisioning

Import a connection, confirm it is active, subscribe a webhook, and list webhooks.

  1. Import an existing customer connection. integration_type, permissions, and categories are required by the Connection schema; permissions is sent empty to inherit the integration defaults.
  2. Read the connection back by id to inspect its paused state before wiring up a webhook.
  3. Subscribe a webhook for the supplied object type and event on the new connection. connection_id, object_type, and event are required by the Webhook schema.
  4. List webhooks to confirm the new subscription is registered in the workspace.
What you'll need to have ready
  • integrationType: The integration type / vendor key for the connection (e.g. hubspot, greenhouse).
  • category: The connection category (e.g. crm, ats, hris, accounting, commerce).
  • objectType: The webhook object_type to subscribe to (e.g. crm_contact, ats_candidate).
  • event: The webhook event to subscribe to — one of created, updated, deleted.
  • hookUrl: The HTTPS URL that webhook payloads will be POSTed to.
For your developer

Arazzo workflow unified-to:connection-webhook-provisioning, 4 operations: createUnifiedConnection → getUnifiedConnection → createUnifiedWebhook → listUnifiedWebhooks. Specs on APIs.io.