Manage Webhook Registrations

A Gateway API webhook automatically sends notifications to a registered destination when selected events occur in Magnit VMS. Use webhook registrations to manage the destination, subscribed events, and secret keys for your supplier organization.

Create a Webhook Registration

  1. Sign in to the Magnit VMS portal as a supplier with API Admin or Group API Admin permission.
  2. In the left menu, click API Management, and then select the Webhooks tab in API Credential Management.
  3. Click Add Webhook.
  4. Enter the secure HTTPS callback URL.
  5. Select Individual Supplier or Supplier Group as the designation type.
  6. Select the event types that the receiving system should receive.

    For example, select STAFFING_REQUEST_DISTRIBUTED, CANDIDATE_STATUS_CHANGED, or REQUEST_STATUS_CHANGE.

  7. Enter the email address for delivery failure notifications.
  8. Click Submit.

    Copy and securely store the secret key displayed in the confirmation dialog.

Add Webhook registration form

Edit a Webhook Registration

  1. In the left menu, click API Management, and then select the Webhooks tab in API Credential Management.
  2. Find the registration and click Edit.
  3. Update the callback URL, subscribed events, failure email address, or status, and then click Save.
Note:
Review all changes before saving. Edit one registration at a time when changing a callback URL. Changing a callback URL generates a new secret key.
Edit Webhook registration page

View Your Secret Key

  1. On the Webhook Registration List, find the registration created through the API.
  2. Next to the masked secret key, click the View icon.
  3. Copy the decrypted plain-text key.
  4. Click Done or Cancel to mask the value again.

Regenerate the Secret Key

  1. In the left menu, click API Management, and then select the Webhooks tab in API Credential Management.
  2. Find the registration and, in the secret key column, click Regenerate Secret Key.
  3. Review the warning and click Submit.
  4. Copy the new secret key from the dialog and immediately update the receiving system.
Note:
Regenerating the key invalidates the previous key. Notifications can fail verification until the receiving system is updated. Never share a secret key in email, chat, or screenshots.
Regenerate Secret Key confirmation

View Change History

  1. In the left menu, click API Management, and then select the Webhooks tab in API Credential Management.
  2. Find the registration, click the History icon, and then click the Change History tab.
  3. Review the recorded changes.

    The history can include registration creation, callback URL, event, status, and failure-email changes, as well as secret key regeneration.

Webhook Change History dialog

View Delivery History

  1. In the left menu, click API Management, and then select the Webhooks tab in API Credential Management.
  2. Find the registration, click the History icon, and then click the Delivery History tab.
  3. Review the event name, status, delivery date and time, delivery ID, supplier name, entity ID, and failure reason.
  4. For a failed notification, click Replay and review the new delivery result.
Note:
If a notification fails, confirm that the receiving system is available and that the callback URL is correct.
Webhook Delivery History dialog