Webhook Commands

Manage webhook🪝WebhooksEvent notifications sent to your application.View in glossary subscriptions to receive real-time notifications when events occur in your APS☁️APSAutodesk Platform Services - cloud APIs for CAD/BIM automation.View in glossary projects.

Note: Webhook commands require 2-legged OAuth🤖2-legged authServer-to-server authentication without user context.View in glossary. Run raps auth test to verify credentials.

Commands Overview

raps webhook list

List all registered webhook subscriptions.

raps webhook list [--output FORMAT]

Example:

$ raps webhook list
$ raps webhook list --output json

raps webhook create

Create a new webhook subscription for a specific event type.

raps webhook create [OPTIONS]

Options:

• -u, --url <URL> — Callback URL for webhook notifications
• -e, --event <EVENT> — Event type (e.g., dm.version.added)

Example:

$ raps webhook create -e "dm.version.added" -u "https://hooks.example.com/aps"

Note: The callback URL must be publicly reachable. APS will send a validation request to the URL during creation.

raps webhook get

Get details of a specific webhook.

raps webhook get --event <EVENT> --hook-id <HOOK_ID> [OPTIONS]

Options:

• -e, --event <EVENT> — Event type
• --hook-id <HOOK_ID> — Hook ID
• -s, --system <SYSTEM> — System (default: data)

Example:

$ raps webhook get -e "dm.version.added" --hook-id abc123

raps webhook update

Update an existing webhook subscription.

raps webhook update --event <EVENT> --hook-id <HOOK_ID> [OPTIONS]

Options:

• -e, --event <EVENT> — Event type
• --hook-id <HOOK_ID> — Hook ID
• --callback-url <URL> — New callback URL
• --status <STATUS> — New status (active or inactive)
• -s, --system <SYSTEM> — System (default: data)

Example:

$ raps webhook update -e "dm.version.added" --hook-id abc123 --status inactive

raps webhook delete

Delete a webhook subscription.

raps webhook delete --event <EVENT> <HOOK_ID>

Arguments:

• <HOOK_ID> — Hook ID to delete

Options:

• -e, --event <EVENT> — Event type
• -s, --system <SYSTEM> — System (default: data)

Example:

$ raps webhook delete -e "dm.version.added" abc123

raps webhook events

List all available webhook event types.

raps webhook events [--output FORMAT]

Example:

$ raps webhook events
$ raps webhook events --output json

raps webhook test

Test connectivity to a webhook callback URL by sending a test POST request.

raps webhook test [OPTIONS] <URL>

Arguments:

• <URL> — Webhook callback URL to test

Options:

• -t, --timeout <TIMEOUT> — Timeout in seconds (default: 10)

Example:

$ raps webhook test https://hooks.example.com/aps

raps webhook verify-signature

Verify the HMAC signature of a webhook payload to ensure authenticity.

raps webhook verify-signature --signature <SIG> --secret <SECRET> <PAYLOAD>

Arguments:

• <PAYLOAD> — The webhook payload (JSON📋JSONStandard data interchange format.View in glossary string or @file)

Options:

• -s, --signature <SIGNATURE> — The signature from X-Adsk-Signature header
• --secret <SECRET> — The webhook secret🔒SecretEncrypted sensitive configuration value.View in glossary

Example:

$ raps webhook verify-signature --signature "abc123..." --secret "my-secret" '{"event":"dm.version.added"}'

Common Event Types

Next Steps

• Authentication — Set up OAuth🔐OAuthIndustry-standard authorization protocol used by APS.View in glossary credentials
• Data Management — Manage hubs, projects, and folders
• Pipelines — Automate webhook-driven workflows