Example

All the parameters for registering users:

Parameter	Type	Description	Required
eventType	[string]	The events which should notify the system.	Yes
apiKey	string	The API key which is accessible via user setting menu.	Yes
systemId	string	The system id which provided by Oxolo support.	Yes

When registering the eventType, you are able to register the following parameters ( you can register by one or more in eventType array):

Value	Type	Description
videoUpdateStatus	string	When a video has been updated.
videoProgress	string	Incremental progress updates for each video.
userCredit	string	If the credits of the account change.
all	string	All of the above.

curl -X 'POST' 
'https://api.oxolo.com/v1/api/webhooks' 
-H 'accept: application/json' 
-H 'authorization: YOUR_API_KEY'
-d 
'{
  "eventType": ["videoUpdateStatus"],
  "apiKey": "dbf8ed35120f"
  "systemId": "42b69075-952e-42fe-81d4-dbf8ed35120f"
 }'

Result

{
  "results": {
      "eventType": ["videoUpdateStatus"],
      "apiKey": "dbf8ed35120f",
      "createdAt": "2023/06/21 12:00:00",
      "system": {
          "id": "42b69075-952e-42fe-81d4-dbf8ed35120f",
          "name": "system name",
          "webhookUrl": "webhookUrl"
      }
  }
}