Ramp: Webhooks schemas
7 Ramp schemas with complete fields and constraints.
← Webhooks operations · All schemas
Create a mock webhook event for active subscriptions matching the event type — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
event_type | string | Required within parent | Type of the webhook event. One of: 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 |
object_id | string | Required within parent | UUID of the object associated with the event. Format: uuid |
object_metadata | object | Required within parent | Additional metadata associated with the event. |
Create a mock webhook event for active subscriptions matching the event type — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
business_id | string | Required within parent | UUID of the business associated with the event. Format: uuid |
created_at | string | Required within parent | Timestamp when the webhook event was created. |
id | string | Required within parent | Unique identifier for the webhook event. |
object | object | Required within parent | Object associated with the event. |
type | string | Required within parent | Type of the webhook event. 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 |
Creates a new webhook subscription — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
additional_headers | object | Optional | Optional headers to include with webhook requests. Max 5 headers, header names max 100 chars, values max 1000 chars. Maximum length: 5 Additional keys: see wildcard field |
additional_headers.* | string | Additional keys | Maximum length: 1000 Minimum length: 1 |
endpoint_url | string | Required within parent | URL where webhook events will be sent Format: url |
event_types | array | Required within parent | Events that this subscription will receive |
event_types[] | string | Each item | One of: 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 |
Creates a new webhook subscription — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
additional_headers | object | Required within parent | Headers to include with webhook requests Additional keys: see wildcard field |
additional_headers.* | string | Additional keys | |
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 |
secret | string | Required within parent | Secret key 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 |
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 |
Verify a webhook subscription — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
challenge | string | Required within parent | Challenge to verify webhook endpoint |
Verify a webhook subscription — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
success | boolean | Required within parent |