Implement webhooks - Githubissues

casual-simulation / casualos

Casual Open Simulation for the Web

https://ab1.bot

MIT License

50 stars 9 forks source link

Implement webhooks #545

Closed KallynGowdy closed 2 months ago

KallynGowdy commented 2 months ago

Added webhook records.
- When enabled, webhook records make it possible to run AUX code inside a server.
- Webhook records work using a request/response model.
  - When a request is made to execute the webhook, it grabs the configured target AUX file from another record and then executes it.
- Currently, 3 types of targets are supported:
  - data
  - file
  - inst
    - Only supports reading from insts for now.
- Webhooks are secured by markers, just like regular records.
  - publicRead: The publicRead marker can be used to allow anyone to execute the webhook.
  - private: The private marker can be used to only allow the record members to execute the webhook.
- Webhooks have their own user ID.
  - By default, webhooks don't have access to anything except public records.
  - To allow webhooks to access other records, they need to be granted access to those resources.
  - You can find a webhook's user ID by calling os.getWebhook() or by inspecting the webhook through the admin panel.
- Additionally, the following functions have been added:
  - os.recordWebhook(recordName, webhook)
  - os.getWebhook(recordName, address)
  - os.runWebhook(recordName, address, input)
  - os.listWebhooks(recordName, address?)
  - os.listWebhooksByMarker(recordName, marker, address?)
  - os.eraseWebhook(recordName, address)

Closes #528