Platform API
Search
Me
- GETRetrieve user, accesses, roles and more.
- POSTUpdate user profile.
- GETFetch notifications.
- POSTAdd new notification token.
- POSTMark notifications as read.
- POSTMark notifications as deleted.
- GETShow server time.
- POSTUpload avatar.
- POSTClear avatar.
- GETGet your API keys.
- GETGet an API key.
- POSTGenerate an API key.
- POSTUpdate an API key.
- POSTDelete an API key.
Accounts
- GETGet all users.
- GETGet stats of users.
- GETGet an account.
- PUTUpdate an account.
- DELDelete an account.
- POSTCreate an account.
- POSTCreate internal account.
- POSTCreate a service account.
- POSTActivate an account.
- POSTDisable an account.
- POSTEnable platform access for user.
- POSTDisable platform access for user.
- POSTRestore an account.
- GETGet a API keys.
- POSTCreate an API key.
- GETGet an API key.
- POSTUpdate an API key.
- POSTDelete an API key.
- GETGet versions.
- GETGet version.
Endpoints
- GETGet endpoints.
- POSTCreate endpoint.
- GETGet endpoint stats (cached in 5 min intervals).
- GETGet endpoint.
- PUTUpdate endpoint.
- POSTDelete template.
- POSTActivate endpoint.
- POSTDisable endpoint.
- POSTRestore deleted endpoint.
- POSTGet stats from API executions.
- POSTValidate applicable endpoint for given criteria.
- GETGet versions.
- GETGet version.
Components
Role Groups
Groups
Resources
- GETGet resources.
- POSTCreate resource.
- GETGet resource.
- PUTUpdate resource.
- DELDelete resource.
- POSTRestore deleted resource.
- GETGet versions.
- GETGet version.
- GETGet allowed fields for resource.
- GETGet resource items.
- POSTGet resource items.
- POSTClone resource.
- POSTActivate resource.
- POSTDisable resource.
- POSTCreate resource items.
- POSTUpdate resource item.
- POSTUpdate resource items.
- POSTDelete resource items.
- POSTPurge resource items.
Preferences
Secrets
Schema
Files
Automation
- GETGet jobs.
- GETGet job.
- GETGet job logs.
- POSTRetry job.
- POSTCancel jobs.
- POSTDelete job.
- POSTRestore job.
- GETGet templates.
- POSTCreate templates.
- GETGet template.
- PUTUpdate template.
- POSTRun template.
- POSTSubscribe template.
- POSTUnsubscribe template.
- POSTSubscribe template.
- POSTUnsubscribe template.
- POSTDelete template.
- POSTRestore template.
- GETGet versions.
- GETGet version.
- GETSchedule get all.
- POSTSchedule create.
- GETSchedule get one.
- PUTSchedule update.
- POSTSchedule trigger now.
- POSTSchedule resume.
- POSTSchedule pause.
- POSTSchedule delete.
- POSTRestore deleted schedule.
- GETGet versions.
- GETGet version.
- GETGet event history.
- GETGet event history detailed.
- POSTDelete event history.
- POSTRestore event history.
- GETGet events.
- POSTCreate events.
- GETGet event.
- PUTUpdate event.
- POSTTrigger event.
- POSTActivate event.
- POSTDisable event.
- POSTDelete event.
- POSTRestore event.
- GETGet versions.
- GETGet version.
- GETGet webhooks.
- POSTCreate webhook.
- GETGet webhooks.
- POSTCancel webhooks.
- POSTDelete webhook.
- POSTGet webhooks.
Assistant
Create component.
Copy
curl --request POST \
--url https://api.revong.com/api/v1/component \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"componentId": "<string>",
"name": "<string>",
"type": "<string>",
"active": true,
"category": "<string>",
"desc": "<string>"
}
'Components
Create component.
ROLES: COMPONENT_WRITE,COMPONENT_ADMIN USER: true SERVICE ACCOUNT: true
POST
/
api
/
v1
/
component
Create component.
Copy
curl --request POST \
--url https://api.revong.com/api/v1/component \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"componentId": "<string>",
"name": "<string>",
"type": "<string>",
"active": true,
"category": "<string>",
"desc": "<string>"
}
'Authorizations
Bearer token with Platform JWT token or API Key.
Body
application/json
componentId optionally used for existing components
Name is only used for the presentation.
Type of component must be one of: CODE_JS,CODE_TS,CODE_JS_LIB,CODE_TS_LIB,JSON_VALIDATOR.
Activate upon creation.
Category.
Description.
Response
Created.
⌘I