Think of webhooks as real-time data messengers. When specific events, like a button click or form submission, take place, webhooks spring into action. They either send data or initiate other actions.
Webhooks significantly broaden what you can achieve with Oomnitza’s custom objects. However, because of the varied nature of webhook systems, it’s important first to check that they can integrate with Oomnitza’s custom objects. For a webhook to integrate effectively with Oomnitza, it should:
- Enable you to create your own custom payload and add the Oomnitza-Allow-Unknown-Meta-Fields header. The Oomnitza-Allow-Unknown-Meta-Fields header ensures that additional fields included in the payload body are ignored. The Oomnitza-Allow-Unknown-Meta-Fields does not allow an unknown field if the value is an object and not a string.
- Payloads must be flat and consist of key-value pairs. Nested elements cannot be processed.
- Support API authentication and preferably, enable you to add your API key to the header. While it is possible to add an API token as part of the URL (in the form of https://demo.oomnitza.com/api/v3/co_offboarding_employee?api_key=123457), the latter is less secure.
- Require basic acknowledgments (such as an HTTP 201 OK) and does not demand complex security checks, such as the challenge-response methods used by Dropbox or Okta.
In short, while many webhooks can integrate with Oomnitza's custom objects, the ease of the integration depends on functionality of the webhook.
Related links
Adding, revoking, and refreshing an Oomnitza API token
Comments
0 comments
Please sign in to leave a comment.