edubase_post_organization_webhook
Create a webhook for an organization, called on exam results, Quiz practice results, finished exam journeys or manual API triggers, with optional authentication and retries. Returns the webhook identification string.
Instructions
Create a webhook for an organization, called on exam results, Quiz practice results, finished exam journeys or manual API triggers, with optional authentication and retries. Returns the webhook identification string. Test it with edubase_post_organization_webhook_trigger.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| retry | No | How to retry webhook notifications on failure (default: error): - none: no retry - error: delayed retry on any error | |
| title | Yes | title of the webhook | |
| method | No | HTTP method to use for webhook notifications (default: POST) - POST - GET | |
| endpoint | Yes | URL to send webhook notifications to | |
| extra_data | No | additional data (as JSON encoded string) to send with the webhook notification | |
| organization | Yes | organization identification string | |
| trigger_event | Yes | Type of event to trigger webhook: - exam-play-result: triggers when a user (must be member of the organization) completes an exam in the organization - quiz-play-result: triggers when a user (must be member of the organization) completes a quiz in practice mode in the organization - journey-completed: triggers when a user (must be member of the organization) finishes an exam journey started by an exam of the organization (see edubase_get_exam_journey) - api: triggers when a manual API call is made (useful for testing and debugging) | |
| authentication | No | Type of authentication (default: none): - none: no authentication - key: use a secret key (or password) for authentication | |
| authentication_key | No | secret key (or password) to use for authentication, required if authentication is set to key | |
| authentication_send | No | How to send authentication data (default: data): - header: as header field - bearer: as Bearer token in Authorization header - data: as data field (in body or query string) | |
| authentication_send_data | No | name of data field to send authentication data in, required if authentication is set to key and authentication_send is set to data | |
| authentication_key_custom | No | custom field name to use as the authentication key, required if authentication is set to key, mutually exclusive with authentication_key | |
| authentication_send_header | No | name of header field to send authentication data in, required if authentication is set to key and authentication_send is set to header |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| webhook | Yes | ||
| organization | Yes |