The following sections have been provided to help in understanding the Webhooks API and how to configure it in Wordbee Translator:
| Table of Contents |
|---|
What is an API?
An API (or application program interface) consists of the routines, tools and protocols used to build or generate an application. It specifies how each software component will interact with each other.
API calls are used to perform specific operations that the application invoices at runtime to complete a task such as querying, updating, adding, or removing data. They can be used to obtain metadata regarding existing data or to run utilities for administration tasks as well as for other purposes.
API calls are used to Webhooks are used to connect Wordbee Translator to an outside CRM or other type of application. These calls retrieve information from Wordbee and send the information to an outside system at a defined time interval such as 30 minutes, 1 hour, etc.
What is a Webhook?
Webhooks are methods used to augment or alter the behavior of a web page or application using custom, user-defined HTTP callbacks, which trigger an event by sending an HTTP request to the webhooks configured URL. Essentially a webhook is a method for pulling real-time information from another application based on some type of defined event.
They may be used to create events on one website or application that invoke a specific behavior on another. In Wordbee Translator, webhooks may be used to push real-time information to a website or another application based on a configured status change for a Standard or CoDyt project. In order to configure a webhook, you must do the following:
- Define the event to trigger the call.
- Enter a valid URL for the request to be sent to.
- Define the HTTP method: GET, POST, PULL, or DELETE. (For Wordbee it is typically a POST event).
- Choose a content format.
- Enter any additional fields or functions needed to complete the call.
A Webhooks API call might be performed when a project moves from an "in Progress" to a "Completed" status or when it changes from "Not Started" to "In Progress". Here are a few of the status change options offered by Wordbee for the Webhooks API:
- Closed
- Cancelled
- Completed
- Approved
- In Progress
- Not Started
- Not Assigned
- Proposal
When using the Webhooks API, you are able to define a status change for a type of project and then configure a URL and additional information for performing the required call.
How to Enable & Configure the Webhook API
...