TextMaster's Developer Documentation
HomeApp
  • Welcome!
  • Quick Start
    • Postman
    • OpenAPI
  • Overview
    • Resources in the REST API
    • Authentication
    • Troubleshooting
    • Filters
    • Workflow
    • File uploads
    • Loop
  • Guides
    • Integrator best practices
  • Apps
    • About OAuth Apps
    • Building OAuth Apps
      • Creating an OAuth App
      • Authorizing OAuth Apps
      • Scopes for OAuth Apps
    • Managing OAuth Apps
      • Modifying an OAuth App
      • Deleting an OAuth App
  • Webhooks & Events
    • Webhooks
      • Creating webhooks
      • Configuring your server for webhooks
      • Securing webhooks
      • Troubleshooting webhooks
    • Events
  • Integrations
    • Akeneo
      • Getting Started
      • Configuration
      • Usage
      • Monitoring
      • Troubleshooting
    • Salesforce Commerce Cloud
      • Getting Started
      • Configuration
      • Usage
      • Monitoring
      • Troubleshooting
  • Reference
    • Abilities
    • Authors
    • Documents
    • Categories
    • Countries
    • Expertises
    • Glossaries
    • Languages
    • Levels
    • Locales
    • Preferred Authors
    • Projects
    • Project Templates
    • Negotiated Contracts
    • Support Messages
    • Transactions
    • Uploads
    • Users
    • Work Templates
Powered by GitBook
On this page

Was this helpful?

  1. Webhooks & Events

Webhooks

Learn the basics of how webhooks work to help you build and set up integrations.

Webhooks allow you to build or set up integrations, such as OAuth Apps, which subscribe to certain events on TextMaster. When one of those events is triggered, we'll send an HTTP POST payload to the webhook's configured URL. Webhooks can be used to update an external CMS or anything else. You're only limited by your imagination.

Webhooks can be installed on a specific user, or specific resources. Once installed, the webhook will be sent each time one or more subscribed events occurs.

Events

When configuring a webhook, you can use the API to choose which events will send you payloads. Only subscribing to the specific events you plan on handling limits the number of HTTP requests to your server.

Each event corresponds to a certain set of actions that can happen to your account and/or projects. For example, if you subscribe to the document's in_progress event you'll receive detailed payloads every time a document moves to in progress.

PreviousDeleting an OAuth AppNextCreating webhooks

Last updated 3 years ago

Was this helpful?