Ramp: Get all webhook subscriptions
Ramp webhooks.getOutboundWebhookSubscriptionResource: arguments, response, policy and SDK examples.
← Webhooks operations · Get started
Operation ramp.get_outbound_webhook_subscription_resource
Provider route: GET /developer/v1/webhooks. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/ramp with npm, or alter-sdk-ramp with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { RampIntegration } from "@alter-ai/ramp";
async function execute(input: Parameters<RampIntegration["webhooks"]["getOutboundWebhookSubscriptionResource"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new RampIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.webhooks.getOutboundWebhookSubscriptionResource(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_ramp import RampIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = RampIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.webhooks.get_outbound_webhook_subscription_resource(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | array | Root | |
$[] | Model | Each item | Expand Get a webhook subscription by id — response body |
Referenced models: Get a webhook subscription by id — response body
Schemas
Section titled “Schemas”Get a webhook subscription by id — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
business_id | string | Optional | UUID of the business that this webhook subscription is for Format: uuid |
created_at | string | Required within parent | ISO-8601 timestamp when the subscription was created Format: date-time |
endpoint_url | string | Required within parent | URL where webhook events will be sent |
event_types | array | Required within parent | Types of events this subscription will receive |
event_types[] | string | Each item | Known values: applications.status_updated, bills.approved, bills.archived, bills.created, bills.paid, bills.ready_to_sync, bills.rejected, bills.updated, draft_bills.created, entities.created, item_receipts.created, payments.updated, purchase_orders.archived, purchase_orders.created, purchase_orders.updated, reimbursements.batch_payment_reimbursed, reimbursements.ready_for_review, reimbursements.ready_to_sync, reimbursements.sync_requested, spend_requests.comment_created, spend_requests.created, tests.test_event, transactions.all_requirements_met_and_approved_changed, transactions.authorized, transactions.body_coding_updated, transactions.cleared, transactions.declined, transactions.ready_for_review, transactions.ready_to_sync, transactions.receipt_added, transactions.sync_requested, transactions.synced, unified_requests.created, unified_requests.external_approval_request, unified_requests.external_approval_request_reset, unified_requests.modified, unified_requests.node_advanced, unified_requests.override_approved, unified_requests.updated, users.invite_accepted, vendor_agreements.archived, vendor_agreements.created, vendor_agreements.deleted, vendor_agreements.document_added, vendor_agreements.renewal_milestone, vendor_agreements.updated, vendors.activated, vendors.approved, vendors.updated, webhooks.verification |
id | string | Required within parent | Unique identifier for the webhook subscription |
status | string | Required within parent | Current status of the webhook subscription Known values: active, inactive, pending_verification |
updated_at | string | Required within parent | ISO-8601 timestamp when the subscription was last updated Format: date-time |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.get_outbound_webhook_subscription_resource. Catalog operation: get_outbound_webhook_subscription_resource. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.