WebhooksList webhooks
Back to Sofia

Webhooks

List webhooks

Lists the webhooks of the application without their signing secret, which is only returned when the webhook is registered.

GEThttps://api.sofia-post.com/api/v1/webhooks
GET/v1/webhooks
curl -X GET 'https://api.sofia-post.com/api/v1/webhooks' \
  -H "Authorization: Bearer $SOFIA_API_KEY"

Authorizations

  • Authorizationstringrequired

    Your personal key or OAuth access token, sent as Bearer <token>.

Response

200application/json

The webhooks of the application.

  • dataobject[]required

    The webhooks

    Show child attributes
    • idstringrequired

      Identifier of the webhook

    • urlstringrequired

      Address called by Sofia

    • eventsstring[]required

      The subscribed events

    • createdAtstring<date-time>required

      When the webhook was registered

401

The token is missing, unknown, expired or revoked.

403

The token does not have the webhooks:read scope.

4XXapplication/json

Any other error, in the error envelope.