Trigger Test Link Webhook Event
Trigger Test Link Webhook Event
URL
Request
Response
webhook_event
: string
required
An enumeration.
Allowed values:
"link.state_changed"
"link.product_refresh"
"transactions.updates_available"
webhook_idempotency_key
: string
required
Set this to a unique value that you can check against the delivered webhook payload (webhook_idempotency_key
).
id
: string
required
The unique ID for this link.
example: mk_eqkWN34UEoa2NxyALG8pcV
Responses
200
Successful Response
delivery_token
: string
required
400
Link missing webhook configuration.
error_code
: string
required
link_error.bad_config
default: "link_error.bad_config"
Allowed values:
"link_error.bad_config"
error_message
: string
required
documentation_url
: string
required
401
Invalid access_token or insufficent API client scope or unauthorized link access.
403
Forbidden by link owner. The user did not give permission to access this data when linking or testing only supported for sandbox links.
error_code
: string
required
link_error.forbidden_action
default: "link_error.forbidden_action"
Allowed values:
"link_error.forbidden_action"
error_message
: string
required
Error message
example: Accounts access not permitted
documentation_url
: string
required
404
Link not found.
error_code
: string
required
link_error.not_found
default: "link_error.not_found"
Allowed values:
"link_error.not_found"
error_message
: string
required
default: "Link not found."
documentation_url
: string
required
410
Link deleted.
error_code
: string
required
link_error.deleted
default: "link_error.deleted"
Allowed values:
"link_error.deleted"
error_message
: string
required
default: "Link deleted."
documentation_url
: string
required
422
Link error.
error_code
: string
required
link_error.bad_state
default: "link_error.bad_state"
Allowed values:
"link_error.bad_state"
error_message
: string
required
documentation_url
: string
required
link_error_code
: string
required
429
Rate limit exceeded.
error_code
: string
required
api_error.rate_limit_exceeded
default: "api_error.rate_limit_exceeded"
Allowed values:
"api_error.rate_limit_exceeded"
error_message
: string
required
Error message
default: "Rate limit exceeded"
documentation_url
: string
required