Skip to main content
GET
List webhook endpoints

Authorizations

X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Query Parameters

url
string<url>

Filter by endpoint URL using exact match Public HTTPS URL where Syntage sends matching webhook events

Example:

"https://example.com/webhooks/syntage"

events
enum<string>

Filter by event type using exact match Event type delivered to a webhook endpoint

Available options:
credential.created,
credential.updated,
credential.deleted,
link.created,
link.updated,
link.deleted,
extraction.created,
extraction.updated,
invoice.created,
invoice.updated,
invoice.deleted,
tax_return.created,
tax_return.updated,
tax_return.deleted,
file.created,
export.created,
export.updated,
tax_status.created,
tax_status.updated,
tax_status.deleted,
tax_compliance_check.created,
tax_compliance_check.updated,
tax_compliance_check.deleted,
tax_retention.created,
tax_retention.updated,
tax_retention.deleted,
invoice_payment.created,
invoice_payment.updated,
invoice_line_item.created,
invoice_line_item.updated,
electronic_accounting_record.created,
electronic_accounting_record.updated,
rpc_entidades.created,
rpc_entidades.updated,
rpc_socios.created,
rpc_socios.updated,
rpc_acto.created,
rpc_acto.updated,
shareholder_relation.created,
shareholder_relation.updated,
shareholder_relation_source.created,
rug_garantia.created,
rug_garantia.updated,
buro_de_credito_report.created,
buro_de_credito_report.updated,
background_check.created,
sat_certificate.created,
sat_certificate.updated,
company_verification_report.created,
company_verification_report.updated
enabled
boolean

Filter by enabled state Whether Syntage sends matching events to this endpoint

Example:

true

id[lt]
string

Collection cursor pointer to the next page

id[gt]
string

Collection cursor pointer to the previous page

itemsPerPage
integer
default:20

Number of items per page

Required range: 1 <= x <= 1000

Response

Webhook endpoint collection response

@context
string
default:/contexts/WebhookEndpoint
@id
string
default:/webhook-endpoints
@type
string
default:hydra:Collection
hydra:member
object[]
hydra:view
object

Pagination information