Skip to guide content
All guides

Settings & collaboration

Connect other software

Use API keys for access and webhooks for update notifications.

On this page
  1. When do you need an integration?
  2. Create a 2novel API key
  3. Receive webhook notifications
  4. Rotate secrets and recover delivery

When do you need an integration?

Use Integrations when a script, bot or another system needs to work with 2novel. Translating and editing in the application does not require an API key or webhook.

Create a 2novel API key

Go to Settings → Integrations → 2novel API keys. Access depends on your workspace capabilities.

  1. Create a key and name it after the software using it.
  2. Copy it during the one-time reveal and store it in a secret store or private receiver configuration. Never put it in public frontend code.
  3. Use the API reference to make authenticated requests.
  4. Revoke unused keys. If a key is lost, create a new one; you cannot view the old plaintext again.

Receive webhook notifications

A webhook announces that a book has updates; it does not contain the full chapter text. Your receiver uses the API to fetch the data it needs.

  1. Open Webhook notifications and register a public HTTPS endpoint you control.
  2. Select the events your receiver needs.
  3. Save the signing secret shown once and configure signature verification in your receiver.
  4. Send a test, inspect the response code and check receiver logs. A successful response alone does not prove signature verification.
  5. Monitor delivery status. Pause during maintenance and resume when the receiver is ready.

Rotate secrets and recover delivery

Rotating a signing secret requires the receiver to use the new secret; update it promptly. Deleting a webhook stops subsequent deliveries. Consult the API reference for raw-body signature verification and response handling.

Open the API reference

Read next

Need more help?

Include the step you were taking and the error message. Never send passwords, API keys or webhook signing secrets.

Open support