Manage API Keys and Webhooks programmatically

This page details the endpoints for managing API keys and webhooks programmatically. These endpoints allow you to control access to the Request Network API, and receive real-time notifications about important events.

Key Features:

• API Key Management: Create, list, toggle, and delete API keys to control access to your platform's resources. API keys are essential for authenticating your application and ensuring secure communication with the Request Network API.

• Webhook Management: Configure and manage webhooks to receive real-time notifications about events within the Request Network. This enables your application to react instantly to payment confirmations, request updates, and other critical events.

Authentication Requirement:

Most of the endpoints described in this section require an active session_token cookie. This cookie is automatically set in your browser after a successful login. Make sure you've logged in before attempting to use these endpoints.

Authentication

Register a new user

post

Register a new user with an email and password

Body

emailstringrequired

Platform email

passwordstring · min: 8 · max: 100required

Platform password

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.request.network/v1/auth/register' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "[e-mail]",
    "password": "text"
  }'

201

400

429

201

No body

Successfully registered

Login user

post

Login with email and password

Body

emailstringrequired

Platform email

passwordstring · min: 8 · max: 100required

Platform password

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.request.network/v1/auth/login' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "[e-mail]",
    "password": "text"
  }'

200

400

429

200

No body

Successfully logged in

Logout user (Requires Session)

post

Logout and clear session

Requires session_token cookie. If you've logged in, this cookie is already set in your browser.

Header parameters

Cookiestringrequired

Active session cookie (automatically included after login)

Example: session_token=<your-session-token>

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.request.network/v1/auth/logout' \
  --header 'Cookie: session_token=<your-session-token>'

200

401

429

200

No body

Successfully logged out

Manage API Keys

Create API key (Requires Session)

post

Create a new API key for your platform

Requires session_token cookie. If you've logged in, this cookie is already set in your browser.

Header parameters

Cookiestringrequired

Active session cookie (automatically included after login)

Example: session_token=<your-session-token>

Body

labelstring · min: 1 · max: 100required

API key label

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.request.network/v1/key' \
  --header 'Cookie: session_token=<your-session-token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "label": "My API key"
  }'

201

401

429

201

{
  "key": "rn_v1_5f7fucpzhyurwuafwljbgfmzmhyyyf4y"
}

API key created successfully

List API keys (Requires Session)

get

Get all API keys for your platform

Requires session_token cookie. If you've logged in, this cookie is already set in your browser.

Header parameters

Cookiestringrequired

Active session cookie (automatically included after login)

Example: session_token=<your-session-token>

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.request.network/v1/key' \
  --header 'Cookie: session_token=<your-session-token>'

200

401

429

200

[
  {
    "id": "01JKZNG0N658N6A2R45MPEEP4F",
    "label": "My API key",
    "key": "rn_v1_5f7fucpzhyurwuafwljbgfmzmhyyyf4y",
    "isActive": true,
    "createdAt": "2025-02-13T12:45:45.512Z"
  }
]

List of API keys

Toggle API key (Requires Session)

put

Enable or disable an API key

Requires session_token cookie. If you've logged in, this cookie is already set in your browser.

Path parameters

idstringrequired

API key ID

Example: 01JKZNG0N658N6A2R45MPEEP4F

Header parameters

Cookiestringrequired

Active session cookie (automatically included after login)

Example: session_token=<your-session-token>

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.request.network/v1/key/{id}' \
  --header 'Cookie: session_token=<your-session-token>'

200

401

404

429

200

No body

API key toggled successfully

Delete API key (Requires Session)

delete

Permanently delete an API key

Requires session_token cookie. If you've logged in, this cookie is already set in your browser.

Path parameters

idstringrequired

API key ID

Example: 01JKZNG0N658N6A2R45MPEEP4F

Header parameters

Cookiestringrequired

Active session cookie (automatically included after login)

Example: session_token=<your-session-token>

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.request.network/v1/key/{id}' \
  --header 'Cookie: session_token=<your-session-token>'

200

401

404

429

200

No body

API key deleted successfully

Manage Webhooks

Create webhook (Requires Session)

post

Create a new webhook endpoint for receiving notifications

Requires session_token cookie. If you've logged in, this cookie is already set in your browser.

Header parameters

Cookiestringrequired

Active session cookie (automatically included after login)

Example: session_token=<your-session-token>

Body

urlstringrequired

Webhook URL

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.request.network/v1/webhook' \
  --header 'Cookie: session_token=<your-session-token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://example.com/webhook"
  }'

201

400

401

429

201

{
  "id": "01JMMA4WWFT0VAPBAS0GYH70GQ",
  "secret": "9f8688812f6abb01ee7a36934ab10cabab4498a24d2dc080f900ced57617713c"
}

Webhook created successfully

List webhooks (Requires Session)

get

Get all webhooks for your platform

Requires session_token cookie. If you've logged in, this cookie is already set in your browser.

Header parameters

Cookiestringrequired

Active session cookie (automatically included after login)

Example: session_token=<your-session-token>

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.request.network/v1/webhook' \
  --header 'Cookie: session_token=<your-session-token>'

200

401

429

200

[
  {
    "id": "01JMMA4WWFT0VAPBAS0GYH70GQ",
    "url": "https://example.com/webhook",
    "secret": "9f8688812f6abb01ee7a36934ab10cabab4498a24d2dc080f900ced57617713c",
    "isActive": true,
    "createdAt": "2025-02-17T10:50:19.497Z"
  }
]

List of webhooks

Toggle webhook (Requires Session)

put

Enable or disable a webhook

Requires session_token cookie. If you've logged in, this cookie is already set in your browser.

Path parameters

webhookIdstringrequired

Webhook ID

Example: 01JMMA4WWFT0VAPBAS0GYH70GQ

Header parameters

Cookiestringrequired

Active session cookie (automatically included after login)

Example: session_token=<your-session-token>

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.request.network/v1/webhook/{webhookId}' \
  --header 'Cookie: session_token=<your-session-token>'

200

401

404

429

200

No body

Webhook toggled successfully

Delete webhook (Requires Session)

delete

Permanently delete a webhook

Requires session_token cookie. If you've logged in, this cookie is already set in your browser.

Path parameters

webhookIdstringrequired

Webhook ID

Example: 01JMMA4WWFT0VAPBAS0GYH70GQ

Header parameters

Cookiestringrequired

Active session cookie (automatically included after login)

Example: session_token=<your-session-token>

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.request.network/v1/webhook/{webhookId}' \
  --header 'Cookie: session_token=<your-session-token>'

200

401

404

429

200

No body

Webhook deleted successfully

For detailed information on all available endpoints and their parameters, please refer to the full Request Network API Reference