Skip to content

Ramp: Get a webhook subscription by id — response body

Get a webhook subscription by id: response body. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Get a webhook subscription by id — response body

FieldTypePresenceDescription and constraints
$objectRoot
business_idstringOptionalUUID of the business that this webhook subscription is for
Format: uuid
created_atstringRequired within parentISO-8601 timestamp when the subscription was created
Format: date-time
endpoint_urlstringRequired within parentURL where webhook events will be sent
event_typesarrayRequired within parentTypes of events this subscription will receive
event_types[]stringEach itemKnown 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
idstringRequired within parentUnique identifier for the webhook subscription
statusstringRequired within parentCurrent status of the webhook subscription
Known values: active, inactive, pending_verification
updated_atstringRequired within parentISO-8601 timestamp when the subscription was last updated
Format: date-time

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.