BEbeyondwords
Webhooks

List webhooks

Lists webhooks configured for a project.

get/projects/{project_id}/webhooks

Request

  • Base URL
    https://api.beyondwords.io/v1
  • URL
    https://api.beyondwords.io/v1/projects/{project_id}/webhooks
  • Auth
    API key in header X-Api-Key

Query parameters

pagination[limit]integer

'limit' sets the number of results to return in each page.

pagination[offset]integer

'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result.

Response

OK

idinteger

Unique identifier for the object

urlstring

The URL that BeyondWords will send webhook notifications to. This URL must be served over HTTPS

headersobject
enabledboolean

Whether or not the webhook is enabled or disabled Has the value true if enabled. The default is true.

use_static_ipboolean

Whether requests to URL should originate from a static IP address.

createdstring date-time

Time at which the object was created (ISO 8601)

updatedstring date-time

Time at which the object was updated (ISO 8601)

Changes

No recorded changes to this operation across all 2 revisions of this API.