Skip to main content
POST
/
webhook-endpoints
Create webhook endpoint
curl --request POST \
  --url https://api.syntage.com/webhook-endpoints \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "url": "https://example.com/webhooks/syntage",
  "events": [
    "extraction.updated",
    "invoice.created"
  ],
  "enabled": true,
  "contentType": "application/ld+json"
}
'
{
  "@context": "/contexts/WebhookEndpoint",
  "@id": "/webhook-endpoints/91106968-1abd-4d64-85c1-4e73d96fb997",
  "@type": "WebhookEndpoint",
  "id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
  "url": "https://example.com/webhooks/syntage",
  "signingSecret": "54471a278d46c86ec6cd365983552a28",
  "events": [
    "extraction.updated",
    "invoice.created"
  ],
  "enabled": true,
  "contentType": "application/ld+json",
  "createdAt": "2020-01-01T12:15:00.000Z",
  "updatedAt": "2020-01-01T12:15:00.000Z"
}

Authorizations

​
X-API-Key
string
header
required

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

Body

application/json
​
url
string<url>
required

Public HTTPS URL where Syntage sends matching webhook events

Example:

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

​
events
enum<string>[]
required

Event types delivered to this endpoint

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
Example:
["extraction.updated", "invoice.created"]
​
enabled
boolean
default:true
required

Whether Syntage sends matching events to this endpoint

Example:

true

​
contentType
enum<string>
default:application/ld+json
required

Payload content type for webhook deliveries

Available options:
application/ld+json,
application/json

Response

Webhook endpoint resource response

​
@context
string
default:/contexts/WebhookEndpoint
​
@id
string<iri-reference>

Webhook endpoint IRI

Example:

"/webhook-endpoints/91106968-1abd-4d64-85c1-4e73d96fb997"

​
@type
string
default:WebhookEndpoint
​
id
string<uuid>
Example:

"e0a24894-7fbf-48ae-bfb0-efaae30a6319"

​
url
string<url>

Public HTTPS URL where Syntage sends matching webhook events

Example:

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

​
signingSecret
string

Secret used to verify X-Syntage-Signature delivery headers

Example:

"54471a278d46c86ec6cd365983552a28"

​
events
enum<string>[]

Event types delivered to this endpoint

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
Example:
["extraction.updated", "invoice.created"]
​
enabled
boolean
default:true

Whether Syntage sends matching events to this endpoint

Example:

true

​
contentType
enum<string>
default:application/ld+json

Content type used for webhook delivery payloads

Available options:
application/ld+json,
application/json
​
createdAt
string

Date and time the resource was created

Example:

"2020-01-01T12:15:00.000Z"

​
updatedAt
string

Date and time the resource was last updated

Example:

"2020-01-01T12:15:00.000Z"