Watch
Manage watch subscriptions. Subscribe to Australian entities and receive HMAC-signed webhooks when they are deregistered, sanctioned, or change.
https://api.auo.com.au/v1/watch and require your bearer
token.
Create a subscription
POST /v1/watch
["deregistration", "name_change"].["51824753556", "008583542"].201 response returns the subscription and the signing secret. The secret is shown
once, here and on roll, and never again.
List subscriptions
GET /v1/watch
Returns the account’s subscriptions. The response never contains a signing secret.
Get a subscription
GET /v1/watch/{id}
Returns one subscription by id. Never contains a signing secret.
Update a subscription
PATCH /v1/watch/{id}
Update the events, webhook_url, entities, or status of a subscription. Send only
the fields you want to change.
Delete a subscription
DELETE /v1/watch/{id}
Removes the subscription and its watched entities.
Roll the signing secret
POST /v1/watch/{id}/roll
Generates a new signing secret and returns it once. The previous secret stops being
valid. Use this if a secret may have been exposed.
See also
Watch and webhooks
Changes
Authorizations
Bearer token: auo_sk_test_... (sandbox) or auo_sk_live_... (live).
Body
Request body for creating a new watch subscription. Each entity is validated as an ABN (11 digits) or ACN (9 digits).
One or more entity identifiers (ABN or ACN) to watch.
1The event types that should trigger webhook deliveries.
1The type of entity change event that can be watched. Subscriptions receive webhook deliveries for each selected event type.
deregistration, name_change, abn_cancelled, gst_deregistered, banned_match, sanctions_match, external_administration, bankruptcy_petition_filed, charity_status_change, licensing_change, professional_registration_change, relationship_change, austrac_roll_change The HTTPS endpoint to receive webhook POST requests.
Response
Subscription created. The signing secret is returned exactly once.
Response from POST /watch. The secret is the HMAC signing key for verifying incoming webhook payloads. It is shown exactly once and cannot be retrieved again. Store it securely.
A watch subscription. The signing secret is NOT present on this object. It is returned exactly once at creation (POST /watch) and once at roll (POST /watch/:id/roll).
The plaintext HMAC signing secret (whsec_ prefix). Shown once only. Rotate with POST /watch/:id/roll if lost.