Skip to main content
POST
/
realtime
/
v1
/
webhook
/
call
Call Events Registration
curl --request POST \
  --url https://realtime.govworx.net/realtime/v1/webhook/call \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_type": "<string>",
  "auth_token": "<string>",
  "target_url": "<string>"
}
'
{
  "webhook_id": "<string>",
  "error": true,
  "error_message": "<string>"
}

Body

application/json

Information needed to register a webhook handler.

​
event_type
string

Events to register for. Pipe delimited list, single value, or * for all events.

​
auth_token
string

AuthToken that will be sent to the handler with all payloads in the HTTP Authorization header.

​
target_url
string

URL to send the AuthToken and payload to for matching events.

Response

Webhook registered successfully

Result of attempted webhook registration.

​
webhook_id
string

Unique ID for this webhook registration.

​
error
boolean

True if the registration failed, false otherwise.

​
error_message
string

Details about registration failure, or empty if no error.