Webhooks

List org webhooks

get

List org webhooks

Query parameters

entity_idstring · uuidOptional

Unique identifier

authentication_methodstringOptional

Authentication method

Responses

200

Webhook list

application/json

400

Unprocessable Entity

application/json

500

Unprocessable Entity

application/json

get

GET /webhooks HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "data": {
    "authentication_method": "url_secret",
    "company_id": "0194cc3b-863f-42b9-6d49-c493fdc9abef",
    "entity_id": "0194cc3b-863f-ede9-2806-82f2f69a3a00",
    "event_categories_allowed": [
      "all"
    ],
    "id": "0194cc3b-863f-ba0a-967e-0d0813a58a7d",
    "inserted_at": "2025-02-03 14:34:00.639861Z",
    "notification_key": "KXe1JxmdHIcRhAsnbaTBvSGNSQli4I798oGMb8abeMBcKzJoUpWkOQ==",
    "notification_secret": "some_notification_secret",
    "notification_url": "https://mynotificationurl.com/endpoint",
    "oauth_client_id": null,
    "oauth_client_secret": null,
    "oauth_scope": "",
    "oauth_url": null,
    "org_id": "0194cc3b-863f-0aa1-bf79-4db349948332",
    "updated_at": "2025-02-03 14:34:00.639872Z"
  }
}

Get org webhook by ID

get

Get org webhook

Path parameters

webhook_idstring · uuidRequired

Unique identifier

Responses

200

Gotten webhook

application/json

400

Unprocessable Entity

application/json

500

Unprocessable Entity

application/json

get

GET /webhooks/{webhook_id} HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

{
  "data": {
    "authentication_method": "url_secret",
    "company_id": "0194cc3b-863f-42b9-6d49-c493fdc9abef",
    "entity_id": "0194cc3b-863f-ede9-2806-82f2f69a3a00",
    "event_categories_allowed": [
      "all"
    ],
    "id": "0194cc3b-863f-ba0a-967e-0d0813a58a7d",
    "inserted_at": "2025-02-03 14:34:00.639861Z",
    "notification_key": "KXe1JxmdHIcRhAsnbaTBvSGNSQli4I798oGMb8abeMBcKzJoUpWkOQ==",
    "notification_secret": "some_notification_secret",
    "notification_url": "https://mynotificationurl.com/endpoint",
    "oauth_client_id": null,
    "oauth_client_secret": null,
    "oauth_scope": "",
    "oauth_url": null,
    "org_id": "0194cc3b-863f-0aa1-bf79-4db349948332",
    "updated_at": "2025-02-03 14:34:00.639872Z"
  }
}

Create org webhook

post

Create org webhook

Query parameters

entity_idstring · uuidOptional

Unique identifier

Body

Org webhook creation parameters for IAM access

authentication_methodstringRequired

Webhook authentication method

entity_idstring · uuid | nullableOptional

Entity ID

event_categories_allowedarray | nullableOptional

Event categories

notification_keystring | nullableOptional

Notification Key

notification_secretstring | nullableOptional

Notification Secret

notification_urlstringRequired

Notification URL

oauth_client_idstring | nullableOptional

OAuth Client ID

oauth_client_secretstring | nullableOptional

OAuth Client Secret

oauth_scopestring | nullableOptional

OAuth scope

oauth_urlstring | nullableOptional

OAuth URL

Responses

201

Created webhook

application/json

400

Unprocessable Entity

application/json

500

Unprocessable Entity

application/json

post

POST /webhooks HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 395

{
  "authentication_method": "url_secret",
  "entity_id": "0194cc3b-88fc-dfbf-b57f-2fc8b397cacb",
  "event_categories_allowed": [
    "all"
  ],
  "notification_key": "KXe1JxmdHIcRhAsnbaTBvSGNSQli4I798oGMb8abeMBcKzJoUpWkOQ==",
  "notification_secret": "some_notification_secret",
  "notification_url": "https://mynotificationurl.com/endpoint",
  "oauth_client_id": null,
  "oauth_client_secret": null,
  "oauth_scope": "",
  "oauth_url": null
}

{
  "data": {
    "authentication_method": "url_secret",
    "company_id": "0194cc3b-863f-42b9-6d49-c493fdc9abef",
    "entity_id": "0194cc3b-863f-ede9-2806-82f2f69a3a00",
    "event_categories_allowed": [
      "all"
    ],
    "id": "0194cc3b-863f-ba0a-967e-0d0813a58a7d",
    "inserted_at": "2025-02-03 14:34:00.639861Z",
    "notification_key": "KXe1JxmdHIcRhAsnbaTBvSGNSQli4I798oGMb8abeMBcKzJoUpWkOQ==",
    "notification_secret": "some_notification_secret",
    "notification_url": "https://mynotificationurl.com/endpoint",
    "oauth_client_id": null,
    "oauth_client_secret": null,
    "oauth_scope": "",
    "oauth_url": null,
    "org_id": "0194cc3b-863f-0aa1-bf79-4db349948332",
    "updated_at": "2025-02-03 14:34:00.639872Z"
  }
}

Delete org webhook

delete

Delete org webhook

Path parameters

webhook_idstring · uuidRequired

Unique identifier

Query parameters

entity_idstring · uuidOptional

Unique identifier

Responses

204

Response

application/json

Responsestring · stringExample: No Content

400

Unprocessable Entity

application/json

500

Unprocessable Entity

application/json

delete

DELETE /webhooks/{webhook_id} HTTP/1.1
Host: api.sandbox.trio.com.br
Accept: */*

No Content

Update org webhook

put

Update org webhook

Path parameters

webhook_idstring · uuidRequired

Unique identifier

Body

Org webhook update parameters for communication

authentication_methodstring | nullableOptional

Webhook authentication method

entity_idstring · uuid | nullableOptional

Entity ID

event_categories_allowedarray | nullableOptional

Event categories

notification_secretstring | nullableOptional

Notification Secret

notification_urlstring | nullableOptional

Notification URL

oauth_client_idstring | nullableOptional

OAuth Client ID

oauth_client_secretstring | nullableOptional

OAuth Client Secret

oauth_scopestring | nullableOptional

OAuth scope

oauth_urlstring | nullableOptional

OAuth URL

Responses

200

Updated webhook

application/json

400

Unprocessable Entity

application/json

500

Unprocessable Entity

application/json

put

PUT /webhooks/{webhook_id} HTTP/1.1
Host: api.sandbox.trio.com.br
Content-Type: application/json
Accept: */*
Content-Length: 317

{
  "authentication_method": "url_secret",
  "entity_id": "0194cc3b-89e9-bf25-d9f3-45bc3540b8ff",
  "event_categories_allowed": [
    "all"
  ],
  "notification_secret": "some_notification_secret",
  "notification_url": "https://mynotificationurl.com/endpoint",
  "oauth_client_id": null,
  "oauth_client_secret": null,
  "oauth_scope": "",
  "oauth_url": null
}

{
  "data": {
    "authentication_method": "url_secret",
    "company_id": "0194cc3b-863f-42b9-6d49-c493fdc9abef",
    "entity_id": "0194cc3b-863f-ede9-2806-82f2f69a3a00",
    "event_categories_allowed": [
      "all"
    ],
    "id": "0194cc3b-863f-ba0a-967e-0d0813a58a7d",
    "inserted_at": "2025-02-03 14:34:00.639861Z",
    "notification_key": "KXe1JxmdHIcRhAsnbaTBvSGNSQli4I798oGMb8abeMBcKzJoUpWkOQ==",
    "notification_secret": "some_notification_secret",
    "notification_url": "https://mynotificationurl.com/endpoint",
    "oauth_client_id": null,
    "oauth_client_secret": null,
    "oauth_scope": "",
    "oauth_url": null,
    "org_id": "0194cc3b-863f-0aa1-bf79-4db349948332",
    "updated_at": "2025-02-03 14:34:00.639872Z"
  }
}

PreviousDevelopers NextInvoice installments

Last updated 7 months ago

Was this helpful?