GSAPI Webhook Adapter

Go to Interfaces → Adapters, then select New Adapter in the Management menu.

This opens a wizard to choose the adapter profile.

4. Selecting the Webhook Configuration Profile

Choose Webhook Configuration as the adapter profile.
This loads all fields required for webhook delivery, including event selection and authentication configuration. [GSAPI_Cont...ansactions | Word]

Figure 2: Selecting the Webhook Configuration profile

You will then be prompted to name the adapter.

5. Main Webhook Adapter Settings

The main configuration form contains:

• Events to replicate
• Target URL
• Transfer mode (HTTP/HTTPS, Basic Auth, OAuth2, SFTP alpha)
• Authentication details
• Payload configuration
• Optional custom headers

These settings define how and where Good Sign sends the outgoing webhook messages. [GSAPI_Cont...ansactions | Word]

Figure 3: Webhook Adapter configuration form

6. Target URL and Authentication

Different transfer modes present different authentication options.

Target URL
The endpoint where Good Sign will POST the JSON payload.

Authentication methods include:

• Basic authentication
• OAuth2 client credentials (token endpoint, client ID/secret, scope)
• SFTP (alpha)

Each mode adds its own fields to the configuration screen.

Figure 4: Example of oauth2 selection

7. Customized Webhook Events (Advanced)

Webhook events are normally chosen from a predefined list.
However, Webhook Adapters also support custom events, defined via prepared queries stored in:

dbo.ppv_type_66_preparedqueries

This table defines:

• event description
• actions that trigger the event
• SQL query or stored procedure producing the JSON payload
• visibility rules

The query produces the JSON body sent to the target system.
Examples include order‑line synchronizations or integration‑specific notifications. 

Figure 5: Example of a custom webhook prepared query

8. Standard Webhook JSON Payloads

All webhook notifications follow a common structure based on Good Sign’s change history.

A typical payload includes fields such as:

• scheme (e.g., Organization)
• action (“Created”, “Modified”, “Deleted”)
• primary identifiers
• parent and hierarchy references
• optional metadata fields

Only fields that have values are included in the final JSON. [GSAPI_Cont...ansactions | Word]

9. Summary

10. Consultant Notes (Advanced)

Event selection strategy
Choose only the required events to prevent unnecessary load on both sides.

Custom webhook events
Prepared queries must return valid JSON.
These can combine multiple tables or business rules as needed.

Debugging outbound calls
Use tools such as webhooks.site or requestbin, and check Adapter logs inside Good Sign.

Performance considerations

• Avoid high‑frequency webhook floods
• Ensure the target system can handle sustained inbound traffic
• Consider batching custom event logic when needed