Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Creating Your First Event Notification

While on the Event Notification Dashboard, use the following steps to create your first notifications.

1: Create a New Callback

  1. From the dashboard, click + New in the top-right corner.

  2. You'll navigate to the callback configuration page

2: Configure Basic Settings

  • Callback Name (Required)

    • Enter a descriptive name to identify this callback Example: "Salesforce Transaction Updates" or "Customer Portal Notifications"

  • Callback URL (Required)

    • Enter your HTTPS endpoint URL Must use HTTP or HTTPS protocol Example: https://api.yourcompany.com/webhooks/conga-events

  • Status

    • Toggle between Active and Inactive. Inactive callbacks won't send notifications. By default, new callbacks are set to Active.

3: Select Events

Click the Events tab to choose which events trigger notifications.

Account Events (Transaction Lifecycle)

Events related to transaction-level activities:
Event NameDescriptionWhen it Fires
Transaction CreatedNew transaction initiatedWhen a transaction is first created
Transaction ActivatedTransaction made activeWhen a transaction becomes active for signing
Transaction DeactivatedTransaction deactivatedWhen a transaction is paused or deactivated
Transaction ArchivedTransaction archivedWhen a transaction is moved to archive
Transaction TrashedTransaction moved to trashWhen a transaction is soft-deleted
Transaction RestoredTransaction restored from trashWhen a trashed transaction is recovered
Transaction DeletedTransaction permanently deletedWhen a transaction is permanently removed
Transaction Ready For CompletionReady for final completionWhen all signatures are collected
Transaction ExpiredTransaction expiredWhen a transaction expires without completion
Template CreatedNew template createdWhen a new signing template is created
Participant Events (Signer Actions)
Events related to participant interactions:
Event NameDescriptionWhen it Fires
Document ViewedParticipant viewed documentWhen a recipient opens the document
Document SignedParticipant signedWhen a recipient completes their signature
Recipient Completed SigningRecipient finished all signaturesWhen a recipient completes their entire signing process
Transaction CompletedAll parties signedWhen all participants have signed
Transaction DeclinedTransaction declinedWhen a recipient declines to sign
Role ReassignedRole reassigned to new recipientWhen a signing role is transferred
Transaction Attachment AddedAttachment addedWhen a document attachment is added
Email BounceEmail notification bouncedWhen an email to a recipient bounces
Recipient LockedRecipient locked outWhen a recipient exceeds authentication attempts
KBA FailureKnowledge-based auth failedWhen KBA verification fails
Selecting Events
  • Select All / Select None: Bulk select all events in a category

  • Search box: Filter events by name

  • Individual checkboxes: Select specific events

  • Selected events counter: Shows "X of 20 events selected"

Selected events appear as badges at the bottom of the screen.
Important: Only subscribe to events you need. Each event generates a webhook call to your endpoint.

4: Configure Advanced Options (Optional)

Click the Advanced Options tab for additional settings.

Toggle Include the full document bytes (base64 encoded) in the callback payload

When Disabled (Default):

  • Webhook includes only metadata and document references

  • Smaller payload size

  • Use Conga Sign APIs to retrieve document content when needed

  • Recommended for most use cases

When Enabled:

  • Full document content included as base64-encoded data in the payload

  • Applies only to Transaction Completed events

  • Significantly larger payloads (can be several MB)

  • Ensure your endpoint can handle large payloads

5: Configure Authentication

Click the Authentication tab to secure your webhook endpoint.

Authentication Type Options:

  • None:

    • No authentication headers sent

    • Endpoint receives requests without authentication

    • Use for: Internal/trusted endpoints, testing environments

  • Basic Authentication:

    • Sends API key in Authorization header

    • Format: Authorization: Bearer <your-api-key>

    • Use for: Simple API authentication, basic security requirements.

      • Configuration:

        • Select Basic Authentication

        • Enter Username

        • Enter Password

        • Credentials are Base64-encoded and sent as: Authorization: <Basic64String>

  • OAuth 2.0:

    • Full OAuth 2.0 client credentials flow

    • Tokens automatically refreshed

    • Use for: Enterprise integrations, high-security requirements

      • Configuration:

        • Select OAuth 2.0

        • Enter Client ID - Your OAuth application client identifier

        • Enter Client Secret - Your OAuth application secret

        • Enter Authentication Server URL - Token endpoint (e.g.,https://auth.example.com/oauth/token)

        • Enter Scope - Space-separated OAuth scopes (e.g., read/write)

      • The system automatically:

        • Requests access tokens using client credentials

        • Refreshes tokens before expiration

        • Includes tokens in callback requests using Bearer authentication

      • Connector

        • Designed for Salesforce Connector integration

        • Enables Salesforce flows and field updates

        • Use for: Triggering Salesforce automation without writeback

        • Configuration:

        • Contact Conga Support for Connector authentication setup assistance.

6: Preview Payload

Click the Payload Preview tab to see the exact JSON structure sent for each event.

Sample Payload Structure:
{
  "name": "transactionCompleted",
  "sessionUser": "abc",
  "packageId": "abc",
  "message": "Callback Events",
  "documentId": null,
  "createdDate": "2026-01-28T17:37:42.976Z"
}
The preview updates dynamically based on:
  • Selected events

  • Document bytes toggle setting

  • Applied filters

Use this preview to:

  • Understand the data structure

  • Design your endpoint's data processing logic

  • Verify the information available for each event type

7: Test your Callback

Before activating, test your endpoint connectivity:

  1. Ensure you've entered a valid Callback URL

  2. Ensure Status is set to Active

  3. Click the Test button in the top-right corner

Test Process:
  • System sends a test payload to your endpoint

  • Test payload includes first selected event with sample data

  • Your endpoint should respond with HTTP 2xx status codeSample Test Payload:
    {
      "name": "PACKAGE_CREATE",
      "sessionUser": "abc",
      "packageId": "abc",
      "message": "Events from Test api",
      "documentId": null,
      "createdDate": "2026-01-28T17:39:50.962275Z"
    }
Test Results:
Success (Green): Your endpoint responded with HTTP 200-299
  • Message: "Connection Successful. Successfully connected to callback URL (OK)"

  • You can proceed to save.

Failure (Red): Connection failed or error response.
  • Message displays error details and status code

  • Example: "Connection Failed. The callback URL returned an error (NotFound)"

  • Review endpoint URL, network configuration, and authentication settings

8: Save Configuration

  1. Review all settings across tabs

  2. Click Save in the top-right corner

  3. System validates configuration

  4. Success message confirms the callback is saved

The Save button enables only when changes are detected.

Additional Actions:

  • Cancel: Discard unsaved changes and return to dashboard

  • Clear: Reset all fields to start over

  • Delete: Permanently remove the callback (only on existing callbacks)