Quickstart
1
Generate an API Key
To learn how to get an API Key, referer to Authentication section.
2
Get your Workspace ID
Use the request in List workspaces.
Copy the ID of the desired worspace.
3
Select one or more Jobs
Use the request in List Jobs.
Copy the ID of jobs that will trigger an webhook event.
4
Edit the Example Json:
Replace the
jobs
list with the Job IDs retrieved from the previous step.Change the
url
with the endpoint that the webhook must send data.Adapt the body and header accordingly.
Based on the Run job request, edit the url with the
workspace_id
andjob_id
obtained in the previous steps.Execute the request.
You can also explore our collection of specific examples tailored for each tool. These examples provide practical insights and step-by-step instructions to help you get started effectively.
Last updated