raims webhooks | Raims Documentation

Look up syntax, arguments, and options for each command. Use raims COMMAND --help to read the help in your terminal.

`raims webhooks`

Manage webhook endpoints

Shell

raims webhooks [flags]

--help, -h bool default: false
- help for webhooks

Subcommands: raims webhooks create, raims webhooks delete, raims webhooks get, raims webhooks health, raims webhooks list, raims webhooks rotate-secret, raims webhooks set-pause, raims webhooks test, raims webhooks update.

`raims webhooks create`

Create a webhook endpoint

Shell

raims webhooks create [flags]

--data-file string default: empty
- Read the JSON request body from a UTF-8 file, or '-' for stdin
--dry-run bool default: false
- Validate and preview the request without credentials or network access
--events stringArray default: empty
- Set JSON body field events (array<string>, repeat the option for each item, required in the body)
--help, -h bool default: false
- help for create
--idempotency-key string default: empty
- Reuse this optional idempotency key when retrying the same request
--is-active bool default: false
- Set JSON body field is_active (boolean)
--name string default: empty
- Set JSON body field name (string, required in the body)
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)
--url string default: empty
- Set JSON body field url (string, required in the body)

Create a webhook endpoint.

POST /v1/webhooks

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

Read the JSON request body with --data-file PATH, or --data-file - for standard input. You can also provide the body options listed below. Repeat array options for each item. Do not combine file input with body options. Only supplied fields are sent. When listed, --body-null FIELD sends an explicit null for a nullable field. Array size and uniqueness follow the endpoint contract. Objects without dedicated body options and arrays of objects use file input.

JSON body fields:
  events     array<string>  required; allowed: "charge.created", "charge.paid", "charge.canceled", "charge.failed", "refund.requested", "refund.completed", "refund.failed"
  is_active  boolean        optional
  name       string         required
  url        string         required
Nested requirements apply when the parent object is present, or for each supplied array item. Omit an optional field to leave it unspecified; null is accepted only for nullable fields.

JSON body example (save as request.json):
{
  "name": "Pedidos pagos",
  "url": "https://webhooks.example.com/raims",
  "events": [
    "charge.paid"
  ],
  "is_active": true
}
Example values are illustrative. Replace resource IDs and review the request before sending it.

Command example

Shell

raims --profile PROFILE --output json webhooks create --data-file request.json --dry-run
raims webhooks create --events="charge.paid" --name="Pedidos pagos" --url="https://webhooks.example.com/raims" --dry-run

`raims webhooks delete`

Delete a webhook endpoint

Shell

raims webhooks delete WEBHOOK_ID [flags]

--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for delete
--idempotency-key string default: empty
- Reuse this optional idempotency key when retrying the same request
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

Delete a webhook endpoint.

DELETE /v1/webhooks/{webhook_id}

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

Command example

Shell

raims --profile PROFILE --output json webhooks delete WEBHOOK_ID --dry-run

`raims webhooks get`

Get a webhook endpoint

Shell

raims webhooks get WEBHOOK_ID [flags]

--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for get
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

Get a webhook endpoint.

GET /v1/webhooks/{webhook_id}

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

Command example

Shell

raims --profile PROFILE --output json webhooks get WEBHOOK_ID --dry-run

`raims webhooks health`

Get webhook delivery failures

Shell

raims webhooks health WEBHOOK_ID [flags]

--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for health
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

Get webhook delivery failures.

GET /v1/webhooks/{webhook_id}/health

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

Command example

Shell

raims --profile PROFILE --output json webhooks health WEBHOOK_ID --dry-run

`raims webhooks list`

List webhook endpoints

Shell

raims webhooks list [flags]

--after string default: empty
- Read after this opaque cursor (cannot be combined with --before)
--all bool default: false
- Read all pages as separate results (JSON Lines with --output json)
--before string default: empty
- Read before this opaque cursor (cannot be combined with --after)
--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for list
--max-pages int default: 100
- Maximum pages to read with --all (1-10000)
--page-size int64 default: 10
- Results per page (the API normalizes the requested size)
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

List webhook endpoints.

GET /v1/webhooks

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

Command example

Shell

raims --profile PROFILE --output json webhooks list --dry-run

`raims webhooks rotate-secret`

Rotate a webhook signing secret

Shell

raims webhooks rotate-secret WEBHOOK_ID [flags]

--data-file string default: empty
- Read the JSON request body from a UTF-8 file, or '-' for stdin
--dry-run bool default: false
- Validate and preview the request without credentials or network access
--grace-period-seconds integer default: 0
- Set JSON body field grace_period_seconds (integer)
--help, -h bool default: false
- help for rotate-secret
--idempotency-key string default: empty
- Reuse this optional idempotency key when retrying the same request
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

Rotate a webhook signing secret.

POST /v1/webhooks/{webhook_id}/rotate_secret

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

Read the JSON request body with --data-file PATH, or --data-file - for standard input. You can also provide the body options listed below. Repeat array options for each item. Do not combine file input with body options. Only supplied fields are sent. When listed, --body-null FIELD sends an explicit null for a nullable field. Array size and uniqueness follow the endpoint contract. Objects without dedicated body options and arrays of objects use file input.

JSON body fields:
  grace_period_seconds  integer  optional
Nested requirements apply when the parent object is present, or for each supplied array item. Omit an optional field to leave it unspecified; null is accepted only for nullable fields.

JSON body example (save as request.json):
{
  "grace_period_seconds": 86400
}
Example values are illustrative. Replace resource IDs and review the request before sending it.

Command example

Shell

raims --profile PROFILE --output json webhooks rotate-secret WEBHOOK_ID --data-file request.json --dry-run
raims webhooks rotate-secret WEBHOOK_ID --grace-period-seconds=86400 --dry-run

`raims webhooks set-pause`

Pause or resume webhook deliveries using a JSON request

Shell

raims webhooks set-pause WEBHOOK_ID [flags]

--data-file string default: empty
- Read the JSON request body from a UTF-8 file, or '-' for stdin
--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for set-pause
--idempotency-key string default: empty
- Reuse this optional idempotency key when retrying the same request
--is-paused bool default: false
- Set JSON body field is_paused (boolean, required in the body)
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

Pause or resume webhook deliveries using a JSON request.

PATCH /v1/webhooks/{webhook_id}/pause

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

Read the JSON request body with --data-file PATH, or --data-file - for standard input. You can also provide the body options listed below. Repeat array options for each item. Do not combine file input with body options. Only supplied fields are sent. When listed, --body-null FIELD sends an explicit null for a nullable field. Array size and uniqueness follow the endpoint contract. Objects without dedicated body options and arrays of objects use file input.

JSON body fields:
  is_paused  boolean  required
Nested requirements apply when the parent object is present, or for each supplied array item. Omit an optional field to leave it unspecified; null is accepted only for nullable fields.

JSON body example (save as request.json):
{
  "is_paused": true
}
Example values are illustrative. Replace resource IDs and review the request before sending it.

Command example

Shell

raims --profile PROFILE --output json webhooks set-pause WEBHOOK_ID --data-file request.json --dry-run
raims webhooks set-pause WEBHOOK_ID --is-paused=true --dry-run

`raims webhooks test`

Request a test event for a webhook endpoint

Shell

raims webhooks test WEBHOOK_ID [flags]

--dry-run bool default: false
- Validate and preview the request without credentials or network access
--help, -h bool default: false
- help for test
--idempotency-key string default: empty
- Reuse this optional idempotency key when retrying the same request
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)

Request a test event for a webhook endpoint.

POST /v1/webhooks/{webhook_id}/test

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

HTTP 202 means the request is pending. Inspect the returned resource before repeating an operation; this command does not wait for completion.

Command example

Shell

raims --profile PROFILE --output json webhooks test WEBHOOK_ID --dry-run

`raims webhooks update`

Update a webhook endpoint

Shell

raims webhooks update WEBHOOK_ID [flags]

--data-file string default: empty
- Read the JSON request body from a UTF-8 file, or '-' for stdin
--dry-run bool default: false
- Validate and preview the request without credentials or network access
--events stringArray default: empty
- Set JSON body field events (array<string>, repeat the option for each item)
--help, -h bool default: false
- help for update
--idempotency-key string default: empty
- Reuse this optional idempotency key when retrying the same request
--is-active bool default: false
- Set JSON body field is_active (boolean)
--name string default: empty
- Set JSON body field name (string)
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries (for example 30s or 2m)
--url string default: empty
- Set JSON body field url (string)

Update a webhook endpoint.

PATCH /v1/webhooks/{webhook_id}

Uses https://api.raims.com and the credential referenced by the selected profile. The API validates the credential's company, environment and permissions. API keys determine their own environment; --environment is available only with OAuth.

Use --dry-run to validate and preview the request without reading a profile, loading credentials or contacting the API. Add --environment to preview an OAuth request; without it, the preview uses API-key authentication and has no environment header.

OAuth environments accepted by this operation: Sandbox, Production.

Read the JSON request body with --data-file PATH, or --data-file - for standard input. You can also provide the body options listed below. Repeat array options for each item. Do not combine file input with body options. Only supplied fields are sent. When listed, --body-null FIELD sends an explicit null for a nullable field. Array size and uniqueness follow the endpoint contract. Objects without dedicated body options and arrays of objects use file input.

JSON body fields:
  events     array<string>  optional
  is_active  boolean        optional
  name       string         optional
  url        string         optional
Nested requirements apply when the parent object is present, or for each supplied array item. Omit an optional field to leave it unspecified; null is accepted only for nullable fields.

JSON body example (save as request.json):
{
  "events": [
    "charge.paid",
    "refund.completed"
  ]
}
Example values are illustrative. Replace resource IDs and review the request before sending it.

Command example

Shell

raims --profile PROFILE --output json webhooks update WEBHOOK_ID --data-file request.json --dry-run
raims webhooks update WEBHOOK_ID --events="charge.paid" --events="refund.completed" --dry-run