Include webhook error messages

To be notified when an invitation expires or encounters an error, an error_webhook value should be included in invitation creation. This can be the same webhook as the success URL.

The error webhook invocation will include the Identity access token associated with Invitation Service application.

Your application should confirm that the invitation_accepted_webhook matches the value you provided when creating the invitation.

If an error occurs, the end-user is redirected to an error screen.

To create a webhook error:

POST invitation_accepted_webhook (included in Create a user invitation)

• HEADER:

  • Include TID OAuth Bearer token for your application

  • Add a Content-Type of application/JSON.

• Body

  • user_id: {Trimble Identity user ID}

  • invitation_id: {Invitation service ID}

  • invite_email_address: (type=email) - (Invitee’s Email Address)

  • metadata: (type=dict / Optional)

  • status: complete

  • webhook_secret_token: {Token provided on invitation creation}

  • metadata: {metadata from creation}

  • error_message: (type=str / Optional)

Example request body:

{
    "user_id": "18a0550b...",
    "invitation_id": "ad8c2590...",
    "status": "complete",
    "webhook_secret_token": "4316299750...",
    "metadata": {},
    "invite_email_address": "abc@trimble.com"
}